Welcome to the Meteo Weather App documentation! This guide will help you find exactly what you need.
👉 Start here: Getting Started - Get up and running in 3 minutes
| I want to... | Go to... |
|---|---|
| 🚀 Get the app running quickly | Getting Started |
| 💻 Start developing features | Development |
| 📡 Understand the API | API Reference |
| 🚀 Deploy to production | Deployment |
| 🔐 Understand security | Security |
| ♿ Learn about accessibility | Accessibility |
| ⚙️ Work with CI/CD | CI/CD |
| 💾 Optimize database | Database |
| 🎨 Design/UX work | UI/UX |
| Troubleshooting | |
| 📚 Find reference materials | Reference |
| 📦 Browse historical docs | Archive |
Perfect for newcomers - Quickstart guide, architecture overview, developer onboarding
Key Files:
- QUICKSTART.md - 3-minute setup with Docker
- ARCHITECTURE.md - System architecture diagrams
- DEVELOPER_ONBOARDING.md - Comprehensive onboarding
Production deployment guides - Server setup, Docker deployment, CI/CD integration
Key Files:
- DEPLOYMENT_WORKFLOW.md - MANDATORY workflow with CHANGELOG updates
- DEPLOY_NOW.md - Quick deploy reference
- DEPLOYMENT_GUIDE.md - Step-by-step guide
- DEPLOYMENT_TESTING_CHECKLIST.md - Post-deploy verification
Security implementation & audits - Rate limiting, secret scanning, best practices
Score: 9.4/10 | Vulnerabilities: 0
Key Files:
- SECURITY_IMPLEMENTATION_SUMMARY.md - Latest features
- RATE_LIMITING_AND_SECURITY_AUDIT.md - Full audit
- SECURITY_HEADERS.md - HTTP header configuration
WCAG 2.1 Level AA compliance - Screen reader support, keyboard navigation, reduced motion
Score: 8.5-9/10 | WCAG Level AA Compliant
Key Files:
- AUDIT_SUMMARY.md - Quick reference (20 issues)
- PHASE1_COMPLETE.md - Level A implementation
- PHASE2_COMPLETE.md - Level AA implementation
Continuous Integration & Deployment - GitHub Actions, automated testing, deployment pipelines
50-70% faster | 9 parallel jobs
Key Files:
- QUICK_REFERENCE.md - One-page cheat sheet
- DEVELOPER_GUIDE.md - Complete pipeline guide
- OPTIMIZATION_SUMMARY.md - Recent optimizations
Database optimization & migrations - Performance tuning, indexing, partitioning
20-50x faster queries | 585K+ weather records
Key Files:
- PERFORMANCE_FIX_NOV7.md - Critical FULLTEXT index fix
- OPTIMIZATION_COMPLETE.md - All phases summary
- OPTIMIZATION_RECOMMENDATIONS.md - Future improvements
Design & user experience - Material Design 3, layout optimization, density modes
50-60% space reduction | +70% info density
Key Files:
- REDESIGN_SUMMARY.md - Unified Hero Card redesign
- UI_OPTIMIZATION_SUMMARY.md - Material Design 3
- DENSITY_COMPARISON.md - Before/after comparison
Common issues & solutions - Bug fixes, debugging guides, rollback procedures
Key Files:
- TROUBLESHOOTING.md - Common problems
- REGRESSION_PREVENTION.md - "Old Location" bug prevention
- ERROR_MESSAGE_STYLE_GUIDE.md - Error handling (700+ lines)
Developer guides & tools - Code conventions, refactoring docs, migration guides, performance, branching
Key Files:
- AGENTS.md - Repository guidelines
- API_ARCHITECTURE_IMPROVEMENTS.md - API client refactoring (P0-P3A, 1000+ lines)
- BRANCHING_STRATEGY.md - GitHub Flow branching workflow
- VITE_MIGRATION_GUIDE.md - CRA → Vite migration
- PERFORMANCE_OPTIMIZATION.md - Bundle optimization guide
- CODE_QUALITY_AUDIT.md - Code quality analysis
Complete API documentation - All endpoints, request/response examples, authentication
Key Files:
- API_REFERENCE.md - Complete endpoint documentation with examples
- Authentication, Weather, Climate, Locations, Air Quality, AI Features
- Rate limiting, caching, error handling, and pagination guides
Additional materials - Roadmap, promotional content, GitHub topics
Key Files:
- IMPROVEMENTS_TODO.md - Future enhancements
- GITHUB_TOPICS.md - SEO & discoverability
- PROMOTION.md - Launch content templates
Historical documentation - Completed projects, legacy audits, read-only reference
Key Files:
- ERROR_MESSAGE_IMPROVEMENT_STATUS.md - Completed (Nov 5)
- AUDIT_FINDINGS_SUMMARY.md - Repository audit
- REPOSITORY_AUDIT_REPORT.md - Full audit (40K+ lines)
Setting up locally:
Deploying to production:
- Deployment → DEPLOY_NOW.md
- Deployment → DEPLOYMENT_TESTING_CHECKLIST.md
- Security → SECURITY_DEPLOYMENT_CHECKLIST.md
Fixing a bug:
Working on UI:
Optimizing performance:
👤 New Developer: → Getting Started → Development
🚀 DevOps Engineer: → Deployment → CI/CD → Security
🎨 UI/UX Designer: → UI/UX → Accessibility
🔧 Database Admin: → Database → Deployment
🐛 Bug Hunter: → Troubleshooting → Development
- ✅ Branching Strategy: GitHub Flow implementation (Nov 10)
- ✅ CI/CD: 50-70% faster pipeline + infrastructure fixes (Nov 7-10)
- ✅ Accessibility: WCAG Level AA compliance (Nov 7)
- ✅ Database: 20-50x query performance (Nov 7)
- ✅ UI/UX: Material Design 3 implementation (Nov 6)
- ✅ Security: 9.4/10 score, 0 vulnerabilities (Nov 5)
- Tests: 476/476 passing
- Coverage: Frontend 33.65%, Backend 60-65%
- Security Score: 9.4/10
- Accessibility Score: 8.5-9/10
- Performance: 282x faster cached responses
- Read Getting Started → QUICKSTART.md
- Follow setup instructions
- Explore the app at http://localhost:3000
- Study Getting Started → ARCHITECTURE.md
- Review Development → AGENTS.md
- Read recent CHANGELOG.md
- Pick an issue from GitHub
- Follow CONTRIBUTING.md
- Reference relevant docs from this hub
- Submit your first PR!
- Check relevant category README (links above)
- Search documentation using GitHub search or
grep - Browse troubleshooting for common issues
- Check CLAUDE.md for AI assistant quick reference
- Open a GitHub issue if stuck
Found an error or want to improve documentation?
- File location: All docs in
docs/with category subdirectories - Guidelines: Clear, concise, actionable
- Format: Markdown with emoji icons for visual scanning
- Links: Use relative paths (
../category/file.md) - Submit: Open a PR with your improvements
Last Updated: November 10, 2025 | Maintained by: Michael Buckingham
Quick Links:
- 🏠 Main README
- 🤖 CLAUDE.md - AI assistant context
- 🤝 CONTRIBUTING.md
- 🔒 SECURITY.md
- 📜 CHANGELOG.md