docs

LearnSpeak Documentation

Welcome to the LearnSpeak documentation! This directory contains all the guides and reference materials for the project.

Getting Started

• QUICKSTART.md - Get up and running in 5 minutes
  • Docker Compose setup
  • Manual development setup
  • Quick API testing

Deployment

• DEPLOYMENT.md - Complete production deployment guide
  • Production build options
  • Docker deployment
  • Environment configuration
  • Security checklist
  • Troubleshooting

Project Requirements

• QUESTIONS.md - Original requirements gathering questions
• ANSWERS.md - Project owner's requirements and decisions
  • Platform goals and scope
  • User management requirements
  • Learning content structure
  • Feature priorities

Additional Documentation

• ../README.md - Main project README with overview
• ../design/PROGRESS.md - Project timeline and sprint progress
• ../backend/README.md - Backend API documentation
• ../frontend/README.md - Frontend architecture and setup

Quick Links

For Developers

1. Start here: QUICKSTART.md
2. Then read: Backend README
3. Understand: Frontend README

For Deployment

1. Read: DEPLOYMENT.md
2. Check: Security checklist in DEPLOYMENT.md
3. Review: Environment variables in backend/.env.example

For Product Planning

1. Review: ANSWERS.md - Core requirements
2. Track: ../design/PROGRESS.md - Implementation status
3. Design: ../design/html/ - UI mockups