mirror of
https://github.com/dograh-hq/dograh.git
synced 2026-06-07 07:55:16 +02:00
66b085dde2
* docs: add windows commands for developer setup * feat: add windows scripts * fix(ui): make dev script cross-platform with cross-env * feat(scripts): enhance migration scripts for Alembic environment setup and add virtual environment activation
47 lines
1.3 KiB
Markdown
47 lines
1.3 KiB
Markdown
# 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_dev.sh
|
|
|
|
# Stop all services
|
|
./scripts/stop_services.sh
|
|
```
|
|
|
|
On Windows (PowerShell):
|
|
```powershell
|
|
.\scripts\start_services_dev.ps1
|
|
.\scripts\stop_services.ps1
|
|
```
|
|
|
|
## Environment Configuration
|
|
|
|
- `api/.env` - Backend environment variables
|
|
- `ui/.env` - Frontend environment variables
|