diff --git a/README.md b/README.md index e1f5e1c..50e5cdd 100644 --- a/README.md +++ b/README.md @@ -87,6 +87,42 @@ DialogWeaver is built as a modern, service-oriented monorepo. This design provid --- +📁 Project Structure +``` +📦 DialogWeaver +├─ 📂 .github # GitHub configurations and automation +│ ├─ 📂 ISSUE_TEMPLATE # Templates for reporting issues (bugs, features) +│ └─ 📂 workflows # GitHub Actions workflows (CI/CD, automated tests) +│ +├─ 📂 api # Backend API service +│ ├─ 📂 alembic # Database migration scripts (versioned) +│ ├─ 📂 app # Core API logic (routes, controllers, models) +│ ├─ 📂 tests # Unit & integration tests for API +│ ├─ 📄 Dockerfile # Dockerfile to containerize the API +│ ├─ 📄 alembic.ini # Alembic config for database migrations +│ ├─ 📄 main.py # API server entry point +│ └─ 📄 requirements.txt # Python dependencies for API +│ +├─ 📂 docs # Documentation and images +│ ├─ 📄 Architecture.png # Project architecture diagram +│ ├─ 📄 gssoc.png # GSSoC-related image +│ └─ 📄 logo.jpg # Project logo +│ +├─ 📂 engine # Core engine/service module +│ ├─ 📂 openvoiceos_engine # Main engine logic for OpenVoiceOS +│ ├─ 📂 telephony_server # Telephony server logic (SIP, VoIP, calls) +│ ├─ 📄 Dockerfile # Dockerfile to containerize engine service +│ ├─ 📄 main.py # Engine service entry point +│ └─ 📄 requirements.txt # Python dependencies for engine +│ +├─ 📄 .env.sample # Sample environment variables template +├─ 📄 .gitignore # Git ignore rules +├─ 📄 CONTRIBUTING.md # Guidelines for contributors +├─ 📄 LICENSE # Project license +├─ 📄 README.md # Project documentation +└─ 📄 docker-compose.yml # Docker Compose config for multi-service setup + +``` ## Quick Start @@ -148,3 +184,5 @@ This project is licensed under the MIT License - see the **[LICENSE](LICENSE)** + +