# TimeTracker Documentation Welcome to the comprehensive TimeTracker documentation. Everything you need to install, configure, use, and contribute to TimeTracker. --- ## πŸ“– Quick Links - **[πŸš€ Getting Started Guide](GETTING_STARTED.md)** β€” Complete beginner tutorial (⭐ Start here!) - **[Main README](../README.md)** β€” Product overview and quick start - **[Installation & Deployment](#-installation--deployment)** β€” Get TimeTracker running - **[Feature Guides](#-feature-documentation)** β€” Learn what TimeTracker can do - **[Troubleshooting](#-troubleshooting)** β€” Solve common issues --- ## πŸ—ΊοΈ Documentation Map ``` docs/ β”œβ”€β”€ πŸ‘€ User Documentation β”‚ β”œβ”€β”€ Getting Started β”‚ β”œβ”€β”€ Feature Guides β”‚ └── User Guides β”‚ β”œβ”€β”€ πŸ”§ Administrator Documentation β”‚ β”œβ”€β”€ Configuration β”‚ β”œβ”€β”€ Deployment β”‚ β”œβ”€β”€ Security β”‚ └── Monitoring β”‚ β”œβ”€β”€ πŸ‘¨β€πŸ’» Developer Documentation β”‚ β”œβ”€β”€ Contributing β”‚ β”œβ”€β”€ Architecture β”‚ β”œβ”€β”€ Development Setup β”‚ └── Testing β”‚ └── πŸ“š Reference β”œβ”€β”€ API Documentation β”œβ”€β”€ Implementation Notes └── Reports ``` --- ## πŸ‘€ User Documentation ### Getting Started - **[πŸš€ Getting Started Guide](GETTING_STARTED.md)** β€” Complete beginner tutorial (⭐ Start here!) - **[Requirements](REQUIREMENTS.md)** β€” System requirements and dependencies ### User Guides - **[Deployment Guide](guides/DEPLOYMENT_GUIDE.md)** β€” How to deploy TimeTracker - **[Quick Start Guide](guides/QUICK_START_GUIDE.md)** β€” Get started quickly - **[Quick Start Local Development](guides/QUICK_START_LOCAL_DEVELOPMENT.md)** β€” Local development setup ### Feature Documentation - **[πŸ“‹ Complete Features Overview](FEATURES_COMPLETE.md)** β€” Comprehensive documentation of all 120+ features (⭐ Complete reference!) - **[Task Management](TASK_MANAGEMENT_README.md)** β€” Complete task tracking system - **[Client Management](CLIENT_MANAGEMENT_README.md)** β€” Manage clients and relationships - **[Invoice System](INVOICE_FEATURE_README.md)** β€” Generate and track invoices - **[Calendar Features](CALENDAR_FEATURES_README.md)** β€” Calendar view and bulk entry - **[Expense Tracking](EXPENSE_TRACKING.md)** β€” Track business expenses - **[Payment Tracking](PAYMENT_TRACKING.md)** β€” Track invoice payments - **[Budget Alerts & Forecasting](BUDGET_ALERTS_AND_FORECASTING.md)** β€” Monitor project budgets - **[Command Palette](COMMAND_PALETTE_USAGE.md)** β€” Keyboard shortcuts and quick actions - **[Bulk Time Entry](BULK_TIME_ENTRY_README.md)** β€” Create multiple time entries at once - **[Weekly Time Goals](WEEKLY_TIME_GOALS.md)** β€” Set and track weekly hour targets See [features/](features/) for additional feature documentation. --- ## πŸ”§ Administrator Documentation ### Configuration - **[Docker Compose Setup](admin/configuration/DOCKER_COMPOSE_SETUP.md)** β€” Docker deployment guide - **[Docker Public Setup](admin/configuration/DOCKER_PUBLIC_SETUP.md)** β€” Production deployment - **[Docker Startup Troubleshooting](admin/configuration/DOCKER_STARTUP_TROUBLESHOOTING.md)** β€” Fix startup issues - **[Email Configuration](admin/configuration/EMAIL_CONFIGURATION.md)** β€” Email setup - **[OIDC Setup](admin/configuration/OIDC_SETUP.md)** β€” OIDC/SSO authentication setup ### Deployment - **[Version Management](admin/deployment/VERSION_MANAGEMENT.md)** β€” Managing versions - **[Release Process](admin/deployment/RELEASE_PROCESS.md)** β€” Release workflow - **[Official Builds](admin/deployment/OFFICIAL_BUILDS.md)** β€” Official build information ### Security - **[Security Documentation](admin/security/)** β€” Security guides and configuration - See [admin/security/](admin/security/) for all security-related documentation ### Monitoring - **[Monitoring Documentation](admin/monitoring/)** β€” Monitoring and analytics setup - See [admin/monitoring/](admin/monitoring/) for telemetry and analytics guides **πŸ“– See [admin/README.md](admin/README.md) for complete administrator documentation** --- ## πŸ‘¨β€πŸ’» Developer Documentation ### Getting Started - **[Contributing Guidelines](development/CONTRIBUTING.md)** β€” How to contribute to TimeTracker - **[Code of Conduct](development/CODE_OF_CONDUCT.md)** β€” Community standards - **[Project Structure](development/PROJECT_STRUCTURE.md)** β€” Codebase organization and architecture ### Development Setup - **[Local Testing with SQLite](development/LOCAL_TESTING_WITH_SQLITE.md)** β€” Quick local testing setup - **[Local Development with Analytics](development/LOCAL_DEVELOPMENT_WITH_ANALYTICS.md)** β€” Development setup with analytics ### Testing - **[Testing Quick Reference](TESTING_QUICK_REFERENCE.md)** β€” Testing overview - **[Testing Coverage Guide](TESTING_COVERAGE_GUIDE.md)** β€” Coverage documentation - See [testing/](testing/) for additional testing documentation ### CI/CD - **[CI/CD Documentation](cicd/)** β€” Continuous integration and deployment - **[Documentation](cicd/CI_CD_DOCUMENTATION.md)** β€” CI/CD overview - **[Quick Start](cicd/CI_CD_QUICK_START.md)** β€” Get started with CI/CD - **[Implementation Summary](cicd/CI_CD_IMPLEMENTATION_SUMMARY.md)** β€” What was implemented - **[GitHub Actions Setup](cicd/GITHUB_ACTIONS_SETUP.md)** β€” Configure GitHub Actions ### Technical Documentation - **[Solution Guide](SOLUTION_GUIDE.md)** β€” Technical solutions and patterns - **[Database Migrations](../migrations/README.md)** β€” Database schema management - **[Implementation Notes](implementation-notes/)** β€” Development notes and summaries **πŸ“– See [development/README.md](development/README.md) for complete developer documentation** --- ## πŸ“š API Documentation - **[REST API](api/REST_API.md)** β€” Complete API reference with all endpoints - **[API Token Scopes](api/API_TOKEN_SCOPES.md)** β€” Understanding token permissions and scopes - **[API Versioning](api/API_VERSIONING.md)** β€” API versioning strategy - **[API Enhancements](api/API_ENHANCEMENTS.md)** β€” Recent API improvements **πŸ“– See [api/README.md](api/README.md) for complete API documentation** --- ## πŸš€ Installation & Deployment ### Quick Start 1. **[Getting Started Guide](GETTING_STARTED.md)** β€” Complete beginner tutorial 2. **[Docker Compose Setup](admin/configuration/DOCKER_COMPOSE_SETUP.md)** β€” Recommended deployment method 3. **[Requirements](REQUIREMENTS.md)** β€” System requirements ### Database & Migrations - **[Database Migrations](../migrations/README.md)** β€” Database schema management with Flask-Migrate - **[Migration Guide](../migrations/MIGRATION_GUIDE.md)** β€” Migrate existing databases - **[Enhanced Database Startup](ENHANCED_DATABASE_STARTUP.md)** β€” Automatic database initialization - **[Database Startup Fix](DATABASE_STARTUP_FIX_README.md)** β€” Database connection troubleshooting - **[Docker Connection Troubleshooting](../docker/TROUBLESHOOTING_DB_CONNECTION.md)** β€” Database connection in Docker --- ## πŸ› οΈ Troubleshooting ### Common Issues - **[Docker Startup Troubleshooting](admin/configuration/DOCKER_STARTUP_TROUBLESHOOTING.md)** β€” Docker won't start - **[Database Connection Issues](../docker/TROUBLESHOOTING_DB_CONNECTION.md)** β€” Can't connect to database - **[PDF Generation Issues](PDF_GENERATION_TROUBLESHOOTING.md)** β€” PDFs not generating - **[Solution Guide](SOLUTION_GUIDE.md)** β€” General problem solving - **[Troubleshooting Transaction Error](TROUBLESHOOTING_TRANSACTION_ERROR.md)** β€” Transaction issues ### Quick Fixes - **Port conflicts**: Change `PORT=8081` in docker-compose command - **Database issues**: Run `docker-compose down -v && docker-compose up -d` - **Permission errors**: Check file ownership with `chown -R $USER:$USER .` - **Migration failures**: See [Database Migrations](../migrations/README.md) --- ## πŸ“ Additional Resources ### Implementation Notes Recent improvements and changes are documented in [implementation-notes/](implementation-notes/): - Layout & UX improvements - Feature implementations - Bug fixes and improvements - Architecture changes ### Reports & Analysis Analysis reports and summaries are available in [reports/](reports/): - Bugfix summaries - Audit reports - Translation analysis ### Feature-Specific Documentation Detailed feature documentation is available in [features/](features/): - Feature guides - Quick start guides - Implementation status ### User Guides Additional user guides are available in [user-guides/](user-guides/): - Step-by-step guides - Tips and tricks - Best practices --- ## πŸ” Documentation by Role ### For New Users 1. Start with **[Main README](../README.md)** for product overview 2. Follow **[Getting Started Guide](GETTING_STARTED.md)** for installation 3. Review **[Requirements](REQUIREMENTS.md)** to check system compatibility 4. Explore **[Feature Documentation](#-feature-documentation)** to learn features ### For Administrators 1. Follow **[Docker Compose Setup](admin/configuration/DOCKER_COMPOSE_SETUP.md)** for deployment 2. Review **[Version Management](admin/deployment/VERSION_MANAGEMENT.md)** for updates 3. Set up **[Email Configuration](admin/configuration/EMAIL_CONFIGURATION.md)** if needed 4. Configure **[OIDC/SSO](admin/configuration/OIDC_SETUP.md)** for authentication 5. See **[admin/README.md](admin/README.md)** for complete admin documentation ### For Developers 1. Read **[Contributing Guidelines](development/CONTRIBUTING.md)** before making changes 2. Review **[Project Structure](development/PROJECT_STRUCTURE.md)** to understand codebase 3. Check **[Solution Guide](SOLUTION_GUIDE.md)** for technical patterns 4. Use **[Local Testing with SQLite](development/LOCAL_TESTING_WITH_SQLITE.md)** for development 5. See **[development/README.md](development/README.md)** for complete developer documentation ### For Troubleshooting 1. Check **[Docker Startup Troubleshooting](admin/configuration/DOCKER_STARTUP_TROUBLESHOOTING.md)** 2. Review **[Database Connection Issues](../docker/TROUBLESHOOTING_DB_CONNECTION.md)** 3. Consult **[Solution Guide](SOLUTION_GUIDE.md)** for common problems 4. Check specific feature documentation if issue is feature-related --- ## πŸ“ Documentation Structure ``` docs/ β”œβ”€β”€ README.md # This file - documentation index β”œβ”€β”€ GETTING_STARTED.md # Beginner tutorial β”œβ”€β”€ REQUIREMENTS.md # System requirements β”œβ”€β”€ FEATURES_COMPLETE.md # Complete features list β”‚ β”œβ”€β”€ guides/ # User-facing guides β”‚ β”œβ”€β”€ DEPLOYMENT_GUIDE.md β”‚ β”œβ”€β”€ QUICK_START_GUIDE.md β”‚ └── ... β”‚ β”œβ”€β”€ admin/ # Administrator documentation β”‚ β”œβ”€β”€ configuration/ # Configuration guides β”‚ β”œβ”€β”€ deployment/ # Deployment guides β”‚ β”œβ”€β”€ security/ # Security documentation β”‚ └── monitoring/ # Monitoring & analytics β”‚ β”œβ”€β”€ development/ # Developer documentation β”‚ β”œβ”€β”€ CONTRIBUTING.md β”‚ β”œβ”€β”€ CODE_OF_CONDUCT.md β”‚ β”œβ”€β”€ PROJECT_STRUCTURE.md β”‚ └── ... β”‚ β”œβ”€β”€ api/ # API documentation β”‚ β”œβ”€β”€ REST_API.md β”‚ β”œβ”€β”€ API_TOKEN_SCOPES.md β”‚ └── ... β”‚ β”œβ”€β”€ features/ # Feature-specific guides β”‚ └── ... β”‚ β”œβ”€β”€ implementation-notes/ # Development notes β”‚ └── ... β”‚ β”œβ”€β”€ testing/ # Testing documentation β”‚ └── ... β”‚ β”œβ”€β”€ reports/ # Reports & analysis β”‚ └── ... β”‚ β”œβ”€β”€ user-guides/ # Additional user guides β”‚ └── ... β”‚ └── cicd/ # CI/CD documentation └── ... ``` --- ## 🀝 Contributing to Documentation Found an error? Want to improve the docs? 1. Check the **[Contributing Guidelines](development/CONTRIBUTING.md)** 2. Make your changes to the relevant documentation file 3. Test that all links work correctly 4. Submit a pull request with a clear description Good documentation helps everyone! πŸ“š --- ## πŸ’‘ Tips for Using This Documentation - **Use the search function** in your browser (Ctrl/Cmd + F) to find specific topics - **Follow links** to related documentation for deeper understanding - **Start with Quick Links** at the top if you're in a hurry - **Browse by role** using the role-based sections above - **Check Implementation Notes** for recent changes and improvements ---
**Need help?** [Open an issue](https://github.com/drytrix/TimeTracker/issues) or check the [troubleshooting section](#-troubleshooting) **Want to contribute?** See our [Contributing Guidelines](development/CONTRIBUTING.md) --- [⬆ Back to Top](#timetracker-documentation)