mirror of
https://github.com/dograh-hq/dograh.git
synced 2026-07-13 11:22:14 +02:00
Chore/add setup and contributing docs (#90)
* chore: add dev setup documentation * Add agents.md files * simplify contributing documentation
This commit is contained in:
parent
e83f3a36d2
commit
59894d7dec
20 changed files with 510 additions and 329 deletions
41
AGENTS.md
Normal file
41
AGENTS.md
Normal file
|
|
@ -0,0 +1,41 @@
|
|||
# Dograh - Project Overview
|
||||
|
||||
Dograh is a voice AI platform for building and deploying conversational AI agents with telephony and WebRTC support.
|
||||
|
||||
## Project Structure
|
||||
|
||||
```
|
||||
dograh/
|
||||
├── api/ # Backend - FastAPI application
|
||||
├── ui/ # Frontend - Next.js application
|
||||
├── scripts/ # Helper scripts for local development
|
||||
├── docs/ # Mintlify documentation
|
||||
├── pipecat/ # Pipecat framework (git submodule)
|
||||
├── docker-compose.yaml # Production/OSS deployment
|
||||
├── docker-compose-local.yaml # Local development services
|
||||
```
|
||||
|
||||
## Tech Stack
|
||||
|
||||
- **Backend**: Python with FastAPI
|
||||
- **Frontend**: Next.js 15 with React 19, TypeScript, Tailwind CSS
|
||||
- **Database**: PostgreSQL with SQLAlchemy (async)
|
||||
- **Cache/Queue**: Redis with ARQ for background tasks
|
||||
- **Storage**: MinIO (S3-compatible) for audio files
|
||||
|
||||
## Local Development
|
||||
|
||||
### Starting Services
|
||||
|
||||
```bash
|
||||
# Start infrastructure services (postgres, redis, minio)
|
||||
./scripts/start_services.sh --dev
|
||||
|
||||
# Stop all services
|
||||
./scripts/stop_services.sh
|
||||
```
|
||||
|
||||
## Environment Configuration
|
||||
|
||||
- `api/.env` - Backend environment variables
|
||||
- `ui/.env` - Frontend environment variables
|
||||
Loading…
Add table
Add a link
Reference in a new issue