mirror of
https://github.com/dograh-hq/dograh.git
synced 2026-06-13 08:15:21 +02:00
Add agents.md files
This commit is contained in:
parent
2fb644546c
commit
e559c86ff3
9 changed files with 180 additions and 6 deletions
50
api/AGENTS.md
Normal file
50
api/AGENTS.md
Normal file
|
|
@ -0,0 +1,50 @@
|
|||
# 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/v1` prefix
|
||||
- Routes are organized by domain (workflow, telephony, campaign, user, etc.)
|
||||
- `routes/main.py` aggregates all routers
|
||||
|
||||
## Database Migrations
|
||||
|
||||
```bash
|
||||
./scripts/makemigrate.sh "description" # Create migration
|
||||
./scripts/migrate.sh # Run migrations
|
||||
```
|
||||
|
||||
## Development
|
||||
|
||||
```bash
|
||||
uvicorn api.app:app --reload --port 8000
|
||||
```
|
||||
1
api/CLAUDE.md
Normal file
1
api/CLAUDE.md
Normal file
|
|
@ -0,0 +1 @@
|
|||
@AGENTS.md
|
||||
Loading…
Add table
Add a link
Reference in a new issue