mirror of
https://github.com/dograh-hq/dograh.git
synced 2026-06-07 07:55:16 +02:00
* chore: add dev setup documentation * Add agents.md files * simplify contributing documentation
1.6 KiB
1.6 KiB
API - Backend Service
FastAPI backend for the Dograh voice AI platform.
Project Structure
api/
├── app.py # Application entry point, FastAPI setup
├── routes/ # API endpoint handlers
├── services/ # Business logic and integrations
├── db/ # Database models and data access
├── schemas/ # Pydantic request/response schemas
├── tasks/ # Background jobs (ARQ)
├── utils/ # Utility functions
├── alembic/ # Database migrations
├── constants.py # Environment variables and constants
└── tests/ # Test suite
Where to Find Things
| Looking for... | Go to... |
|---|---|
| API endpoints | routes/ - each file is a router module, aggregated in routes/main.py |
| Business logic | services/ - organized by domain (telephony, workflow, campaign, etc.) |
| Database models | db/models.py |
| Database queries | db/*_client.py files (repository pattern) |
| Request/response types | schemas/ |
| Background tasks | tasks/ - uses ARQ for async job processing |
| Environment config | constants.py |
API Structure
- All routes are mounted at
/api/v1prefix - Routes are organized by domain (workflow, telephony, campaign, user, etc.)
routes/main.pyaggregates all routers
Database Migrations
./scripts/makemigrate.sh "description" # Create migration
./scripts/migrate.sh # Run migrations
Development
uvicorn api.app:app --reload --port 8000