Skip to content

Update README.md #6

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Hiteshydv001 merged 2 commits into from
Sep 15, 2025
Merged

Update README.md #6

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
420f62b
Update README.md
farah21109 Sep 15, 2025
ee6bdbf
Update README.md
farah21109 Sep 15, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 38 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -148,3 +184,5 @@ This project is licensed under the MIT License - see the **[LICENSE](LICENSE)**