mirror of
https://github.com/DRYTRIX/TimeTracker.git
synced 2026-04-24 13:40:25 -05:00
Dries Peeters
29f7186ee8
Complete reorganization of project documentation to improve discoverability, navigation, and maintainability. All documentation has been restructured into a clear, role-based hierarchy. ## Major Changes ### New Directory Structure - Created `docs/api/` for API documentation - Created `docs/admin/` with subdirectories: - `admin/configuration/` - Configuration guides - `admin/deployment/` - Deployment guides - `admin/security/` - Security documentation - `admin/monitoring/` - Monitoring and analytics - Created `docs/development/` for developer documentation - Created `docs/guides/` for user-facing guides - Created `docs/reports/` for analysis reports and summaries - Created `docs/changelog/` for detailed changelog entries (ready for future use) ### File Organization #### Moved from Root Directory (40+ files) - Implementation notes → `docs/implementation-notes/` - Test reports → `docs/testing/` - Analysis reports → `docs/reports/` - User guides → `docs/guides/` #### Reorganized within docs/ - API documentation → `docs/api/` - Administrator documentation → `docs/admin/` (with subdirectories) - Developer documentation → `docs/development/` - Security documentation → `docs/admin/security/` - Telemetry documentation → `docs/admin/monitoring/` ### Documentation Updates #### docs/README.md - Complete rewrite with improved navigation - Added visual documentation map - Organized by role (Users, Administrators, Developers) - Better categorization and quick links - Updated all internal links to new structure #### README.md (root) - Updated all documentation links to reflect new structure - Fixed 8 broken links #### app/templates/main/help.html - Enhanced "Where can I get additional help?" section - Added links to new documentation structure - Added documentation index link - Added admin documentation link for administrators - Improved footer with organized documentation links - Added "Complete Documentation" section with role-based links ### New Index Files - Created README.md files for all new directories: - `docs/api/README.md` - `docs/guides/README.md` - `docs/reports/README.md` - `docs/development/README.md` - `docs/admin/README.md` ### Cleanup - Removed empty `docs/security/` directory (moved to `admin/security/`) - Removed empty `docs/telemetry/` directory (moved to `admin/monitoring/`) - Root directory now only contains: README.md, CHANGELOG.md, LICENSE ## Results **Before:** - 45+ markdown files cluttering root directory - Documentation scattered across root and docs/ - Difficult to find relevant documentation - No clear organization structure **After:** - 3 files in root directory (README, CHANGELOG, LICENSE) - Clear directory structure organized by purpose and audience - Easy navigation with role-based organization - All documentation properly categorized - Improved discoverability ## Benefits 1. Better Organization - Documentation grouped by purpose and audience 2. Easier Navigation - Role-based sections (Users, Admins, Developers) 3. Improved Discoverability - Clear structure with README files in each directory 4. Cleaner Root - Only essential files at project root 5. Maintainability - Easier to add and organize new documentation ## Files Changed - 40+ files moved from root to appropriate docs/ subdirectories - 15+ files reorganized within docs/ - 3 major documentation files updated (docs/README.md, README.md, help.html) - 5 new README index files created - 2 empty directories removed All internal links have been updated to reflect the new structure.
156 lines
6.9 KiB
Markdown
156 lines
6.9 KiB
Markdown
# TimeTracker Project Structure
|
|
|
|
This document provides an overview of the cleaned up TimeTracker project structure after removing unnecessary files and consolidating the codebase.
|
|
|
|
## 📁 Root Directory Structure
|
|
|
|
```
|
|
TimeTracker/
|
|
├── 📁 app/ # Main Flask application
|
|
├── 📁 assets/ # Static assets (images, screenshots)
|
|
├── 📁 docker/ # Docker configuration files
|
|
├── 📁 templates/ # Additional template files
|
|
├── 📁 tests/ # Test suite
|
|
├── 📁 .github/ # GitHub workflows and configurations
|
|
├── 📁 logs/ # Application logs (with .gitkeep)
|
|
├── 🐳 Dockerfile # Main Dockerfile
|
|
├── 🐳 Dockerfile # Main Dockerfile
|
|
├── 📄 docker-compose.yml # Local development compose
|
|
├── 📄 docker-compose.remote.yml # Remote/production compose (ghcr.io)
|
|
├── 📄 docker-compose.remote-dev.yml # Remote dev/testing compose (ghcr.io)
|
|
├── 📄 requirements.txt # Python dependencies
|
|
├── 📄 app.py # Application entry point
|
|
├── 📄 env.example # Environment variables template
|
|
├── 📄 README.md # Main project documentation
|
|
├── 📄 PROJECT_STRUCTURE.md # This file
|
|
├── 📄 CONTRIBUTING.md # Contribution guidelines
|
|
├── 📄 CODE_OF_CONDUCT.md # Community code of conduct
|
|
├── 📄 LICENSE # GPL v3 license
|
|
├── 📄 GITHUB_WORKFLOW_IMAGES.md # Docker image workflow docs
|
|
├── 📄 DOCKER_PUBLIC_SETUP.md # Public container setup docs
|
|
├── 📄 REQUIREMENTS.md # Detailed requirements documentation
|
|
├── 📄 deploy-public.bat # Windows deployment script
|
|
└── 📄 deploy-public.sh # Linux/Mac deployment script
|
|
```
|
|
|
|
## 🧹 Cleanup Summary
|
|
|
|
### Files Removed
|
|
- `DATABASE_INIT_FIX_FINAL_README.md` - Database fix documentation (resolved)
|
|
- `DATABASE_INIT_FIX_README.md` - Database fix documentation (resolved)
|
|
- `TIMEZONE_FIX_README.md` - Timezone fix documentation (resolved)
|
|
- `Dockerfile.test` - Test Dockerfile (not needed)
|
|
- `Dockerfile.combined` - Combined Dockerfile (consolidated)
|
|
- `docker-compose.yml` - Old compose file (replaced)
|
|
- `deploy.sh` - Old deployment script (replaced)
|
|
- `index.html` - Unused HTML file
|
|
- `_config.yml` - Unused config file
|
|
- `logs/timetracker.log` - Large log file (not in version control)
|
|
- `.pytest_cache/` - Python test cache directory
|
|
|
|
### Files Consolidated
|
|
- **Dockerfiles**: Now only `Dockerfile` and `Dockerfile.simple`
|
|
- **Docker Compose**: Now only `docker-compose.simple.yml` and `docker-compose.public.yml`
|
|
- **Deployment**: Now only `deploy-public.bat` and `deploy-public.sh`
|
|
|
|
## 🏗️ Core Components
|
|
|
|
### Application (`app/`)
|
|
- **Models**: Database models for users, projects, time entries, tasks, and settings
|
|
- **Routes**: API endpoints and web routes including task management
|
|
- **Templates**: Jinja2 HTML templates including task management views
|
|
- **Utils**: Utility functions including timezone management
|
|
- **Config**: Application configuration
|
|
|
|
### Docker Configuration (`docker/`)
|
|
- **Startup scripts**: Container initialization and database setup
|
|
- **Database scripts**: SQL-based database initialization
|
|
- **Configuration files**: Docker-specific configurations
|
|
|
|
### Templates (`templates/`)
|
|
- **Admin templates**: User management and system settings
|
|
- **Error templates**: Error page templates
|
|
- **Main templates**: Core application templates
|
|
- **Project templates**: Project management templates
|
|
- **Report templates**: Reporting and analytics templates
|
|
- **Timer templates**: Time tracking interface templates
|
|
|
|
### Assets (`assets/`)
|
|
- **Screenshots**: Application screenshots for documentation
|
|
- **Images**: Logo and other static images
|
|
|
|
## 🚀 Deployment Options
|
|
|
|
### 1. Local Development
|
|
- **File**: `docker-compose.yml`
|
|
- **Image**: Built from local source
|
|
- **Use case**: Developer workstation
|
|
|
|
### 2. Remote/Production
|
|
- **File**: `docker-compose.remote.yml`
|
|
- **Image**: `ghcr.io/drytrix/timetracker:latest` (or versioned tag)
|
|
- **Use case**: Production deployment
|
|
|
|
### 3. Remote Dev/Testing
|
|
- **File**: `docker-compose.remote-dev.yml`
|
|
- **Image**: `ghcr.io/drytrix/timetracker:development`
|
|
- **Use case**: Pre-release testing
|
|
|
|
## 📚 Documentation Files
|
|
|
|
- **README.md**: Main project documentation and quick start guide
|
|
- **PROJECT_STRUCTURE.md**: This file - project structure overview
|
|
- **TASK_MANAGEMENT_README.md**: Detailed Task Management feature documentation
|
|
- **CONTRIBUTING.md**: How to contribute to the project
|
|
- **CODE_OF_CONDUCT.md**: Community behavior guidelines
|
|
|
|
## ✅ Task Management Feature
|
|
|
|
The Task Management feature is fully integrated into the application with automatic database migration:
|
|
|
|
### Automatic Migration
|
|
- **No manual setup required**: Database tables are created automatically on first startup
|
|
- **Integrated migration**: Migration logic is built into the application initialization
|
|
- **Fallback support**: Manual migration script available if needed
|
|
|
|
### Components Added
|
|
- **Models**: `Task` model with full relationship support
|
|
- **Routes**: Complete CRUD operations for task management
|
|
- **Templates**: Responsive task management interface
|
|
- **Integration**: Tasks linked to projects and time tracking
|
|
- **GITHUB_WORKFLOW_IMAGES.md**: Docker image build workflow
|
|
- **DOCKER_PUBLIC_SETUP.md**: Public container setup guide
|
|
- **REQUIREMENTS.md**: Detailed system requirements
|
|
|
|
## 🔧 Development Files
|
|
|
|
- **requirements.txt**: Python package dependencies
|
|
- **app.py**: Flask application entry point
|
|
- **env.example**: Environment variables template
|
|
- **tests/**: Test suite and test files
|
|
|
|
## 📝 Key Improvements Made
|
|
|
|
1. **Removed Duplicate Files**: Eliminated redundant documentation and configuration files
|
|
2. **Consolidated Docker Setup**: Streamlined to two main container types
|
|
3. **Updated Documentation**: README now reflects current project state
|
|
4. **Timezone Support**: Added comprehensive timezone management (100+ options)
|
|
5. **Clean Structure**: Organized project for better maintainability
|
|
|
|
## 🎯 Getting Started
|
|
|
|
1. **Choose deployment type**: Local dev, remote, or remote-dev
|
|
2. **Follow README.md**: Complete setup instructions
|
|
3. **Use appropriate compose file**: `docker-compose.yml`, `docker-compose.remote.yml`, or `docker-compose.remote-dev.yml`
|
|
4. **Configure timezone**: Access admin settings to set your local timezone
|
|
|
|
## 🔍 File Purposes
|
|
|
|
- **`.gitkeep` files**: Ensure empty directories are tracked in Git
|
|
- **`.github/`**: GitHub Actions workflows for automated builds
|
|
- **`logs/`**: Application log storage (cleaned up, only `.gitkeep` remains)
|
|
- **`LICENSE`**: GPL v3 open source license
|
|
- **`.gitignore`**: Git ignore patterns for temporary files
|
|
|
|
This cleaned up structure provides a more maintainable and focused codebase while preserving all essential functionality and documentation.
|