Project Documentation

This directory contains setup, integration, and operations documentation for the Arogya for Maternal Health project.

Documentation Structure

• getting-started/
  • prerequisites.md: software and accounts required before setup.
  • quickstart.md: fastest way to run the full stack locally.
  • environment-variables.md: required environment variables and examples.
• setup/
  • backend.md: backend installation, migration, and run steps.
  • frontend.md: frontend installation and run steps.
• integrations/
  • telegram.md: Telegram bot, webhook, and local development flow.
  • google-calendar.md: Google service account setup and reminder troubleshooting.
  • ollama.md: local LLM setup with Ollama.
  • rag.md: ingestion, embeddings, and retrieval workflow.
  • intent-routing.md: intent classification and route behavior.
• operations/
  • database-migrations.md: Alembic migration workflow.
  • troubleshooting.md: common issues and fixes.
• architecture/
  • overview.md: high-level system layout and request flow.

Recommended Reading Order

1. getting-started/prerequisites.md
2. getting-started/environment-variables.md
3. setup/backend.md
4. setup/frontend.md
5. getting-started/quickstart.md
6. integrations/ollama.md
7. integrations/rag.md
8. integrations/intent-routing.md
9. integrations/telegram.md
10. integrations/google-calendar.md

Project Root Layout

• backend/: FastAPI application, Alembic migrations, and domain features.
• frontend/: Next.js app (App Router) with auth and UI components.
• data/: source text files for RAG ingestion.
• docs/: project documentation.