From da145801c250e5b9e6ec299a01f102dedf6c5a63 Mon Sep 17 00:00:00 2001 From: PPeitsch Date: Tue, 18 Nov 2025 01:01:34 -0300 Subject: [PATCH 1/4] docs: Update features list and main screenshot placeholder --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 6a60c41..be2e238 100644 --- a/README.md +++ b/README.md @@ -11,11 +11,13 @@ TimeTrack is a simple yet powerful time tracking application designed for managing work hours, leaves, and holidays. Built with Flask and compatible with PostgreSQL or SQLite, it provides a user-friendly interface for tracking your time and analyzing your work patterns. -![TimeTrack Dashboard](https://via.placeholder.com/800x400?text=TimeTrack+Dashboard) +![TimeTrack Calendar View](https://via.placeholder.com/800x400?text=TimeTrack+Calendar+View) ## 🌟 Features +- 🗓️ **Interactive Calendar Log** - Manage your schedule with a drag-and-drop monthly calendar view - 📅 **Flexible Time Entry** - Record multiple clock in/out entries per day +- ⚙️ **Customizable Absence Codes** - Create, edit, and delete your own absence types - 🏖️ **Absence Management** - Track leaves, holidays and other time off - 📊 **Time Analytics** - View daily, weekly and monthly work summaries - 📈 **Automatic Calculations** - Track work hour balances and overtime From e69778245ad565f0032f525491b3cd374533b2e6 Mon Sep 17 00:00:00 2001 From: PPeitsch Date: Tue, 18 Nov 2025 01:02:08 -0300 Subject: [PATCH 2/4] docs: Correct project structure diagram and entry point --- README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index be2e238..55f2bcd 100644 --- a/README.md +++ b/README.md @@ -104,7 +104,8 @@ TimeTrack/ │ ├── config/ # Configuration settings │ ├── db/ # Database management │ ├── models/ # Data models -│ ├── routes/ # Route handlers +│ ├── routes/ # Route handlers (Blueprints) +│ ├── services/ # Business logic (e.g., holiday providers) │ ├── static/ # Static assets (JS, CSS) │ ├── templates/ # HTML templates │ └── utils/ # Utility functions @@ -112,7 +113,7 @@ TimeTrack/ ├── tests/ # Test suite ├── .env # Environment configuration ├── .env.example # Example environment configuration -├── app.py # Application entry point +├── run.py # Application entry point ├── init_db.py # Database initialization script └── requirements.txt # Python dependencies ``` From 70ffb6620469c5a871f764fc79bd33bd3acc813c Mon Sep 17 00:00:00 2001 From: PPeitsch Date: Tue, 18 Nov 2025 01:07:59 -0300 Subject: [PATCH 3/4] docs: Enhance user guides in README --- README.md | 37 +++++++++++++++++++++---------------- 1 file changed, 21 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 55f2bcd..37c44bc 100644 --- a/README.md +++ b/README.md @@ -64,6 +64,7 @@ cp .env.example .env ```bash python init_db.py ``` +> **Note:** This script is interactive and may prompt you to import data, such as public holidays. 6. Run the application: ```bash @@ -74,27 +75,31 @@ flask run ## 📖 Usage -### Manual Time Entry +The application is organized into several key sections accessible from the main navigation bar. -1. Navigate to "Manual Entry" to record your work hours -2. Select a date and whether it's a regular work day or absence -3. For work days, enter your clock-in and clock-out times -4. You can add multiple time entries per day (e.g., for lunch breaks) +### Calendar Log -### Time Summary +This is the main interface for managing your schedule. +- View an entire month at a glance with color-coded day types. +- Click and drag to select one or more days to change their type (e.g., assign a week of vacation). +- Quickly override weekends or holidays to log work on non-standard days. -View a monthly summary of your work hours, including: -- Required hours based on working days -- Actual hours worked -- Balance (overtime or deficit) -- Daily breakdown with detailed information +### Manual Entry -### Time Logs +For detailed time logging on a specific day: +- Select a date and specify whether it's a workday or an absence. +- For workdays, enter multiple clock-in and clock-out times to account for breaks. -Access a chronological log of all your time entries, including: -- Regular work days with specific times -- Absences and holidays -- Daily totals +### Summary + +Get a detailed overview of your logged time for any given month: +- See a summary of required hours, completed hours, and the resulting balance. +- View a day-by-day breakdown of hours worked versus required hours. + +### Settings + +Customize the application to fit your needs: +- Manage absence codes by adding, editing, or deleting types (e.g., "Vacation", "Sick Leave"). ## 📁 Project Structure From 9c99a589b100ab1bf0c40c334845ceda20e37c99 Mon Sep 17 00:00:00 2001 From: PPeitsch Date: Tue, 18 Nov 2025 01:09:05 -0300 Subject: [PATCH 4/4] docs: Update changelog for v1.3.1 --- CHANGELOG.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 74c55e4..d63c71a 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -6,6 +6,12 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). +## [1.3.1] - 2025-08-23 + +### Changed +- Updated the `README.md` file to accurately reflect the current state of the application. The update includes a revised feature list, a corrected project structure diagram, and improved quick start and usage instructions. + + ## [1.3.0] - 2025-08-23 ### Changed @@ -158,6 +164,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 +[1.3.1]: https://github.com/PPeitsch/TimeTrack/compare/v1.3.0...v1.3.1 [1.3.0]: https://github.com/PPeitsch/TimeTrack/compare/v1.2.3...v1.3.0 [1.2.3]: https://github.com/PPeitsch/TimeTrack/compare/v1.2.2...v1.2.3 [1.2.2]: https://github.com/PPeitsch/TimeTrack/compare/v1.2.1...v1.2.2 @@ -174,4 +181,4 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 [1.0.3]: https://github.com/PPeitsch/TimeTrack/compare/v1.0.2...v1.0.3 [1.0.2]: https://github.com/PPeitsch/TimeTrack/compare/v1.0.1...v1.0.2 [1.0.1]: https://github.com/PPeitsch/TimeTrack/compare/v1.0.0...v1.0.1 -[1.0.0]: https://github.com/PPeitsch/TimeTrack/releases/tag/v1.0.0 \ No newline at end of file +[1.0.0]: https://github.com/PPeitsch/TimeTrack/releases/tag/v1.0.0