Welcome to the comprehensive technical documentation for TimeClout, an AI-powered team scheduling and workforce management platform.
This documentation is organized into logical sections to help you find the information you need quickly:
- Overview - Project overview, features, and technology stack
🛠️ Development
- Authentication Debugging - Troubleshooting authentication issues
- Google OAuth Setup - Complete Google OAuth integration guide
🏗️ Architecture
- GraphQL Resolvers - User caching system and resolver optimization
- Backend Translations - Internationalization system using Lingui
🧪 Testing
- E2E Testing - Playwright-based end-to-end testing guide
- User Management Utilities - Test user creation and management utilities
- GitHub Workflows - CI/CD pipeline configuration and auto-merge setup
- Discord Notifications - Workflow status notifications via Discord
- Production Table Protection - DynamoDB deletion protection for production tables
- Setup: Read the Overview to understand the project
- Authentication: Follow Google OAuth Setup for local development
- Testing: Review E2E Testing for testing workflows
- Deployment: Review GitHub Workflows for CI/CD setup
- Monitoring: Check Discord Notifications for workflow monitoring
- Production: Read Production Table Protection for safety measures
- System Design: Review GraphQL Resolvers for performance optimization
- Internationalization: Check Backend Translations for multi-language support
- Authentication: Debugging | OAuth Setup
- Testing: E2E Testing | User Management
- Deployment: Workflows | Notifications
- Operations: Table Protection
- Frontend Developer: Overview, E2E Testing
- Backend Developer: GraphQL Resolvers, Translations
- DevOps Engineer: GitHub Workflows, Table Protection
- QA Engineer: E2E Testing, User Management
When adding new technical documentation:
- Choose the right category from the folder structure above
- Follow the existing format and style
- Update this README to include new documents
- Use clear, descriptive filenames that indicate the content
- Include practical examples and code snippets where relevant
- Repository: GitHub Repository
- Live Application: TimeClout
- Issue Tracker: GitHub Issues
- Discussions: GitHub Discussions
- Technical Issues: Create a GitHub issue
- Documentation: Submit a pull request with improvements
- General Questions: Use GitHub Discussions
- Emergency: Contact the development team directly
Last Updated: $(date) Version: 1.0.0