Skip to content

Commit 63b21a8

Browse files
authored
Merge pull request #6 from farah21109/main
Update README.md
2 parents fa86ac4 + ee6bdbf commit 63b21a8

File tree

1 file changed

+38
-0
lines changed

1 file changed

+38
-0
lines changed

README.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -87,6 +87,42 @@ DialogWeaver is built as a modern, service-oriented monorepo. This design provid
8787

8888

8989
---
90+
📁 Project Structure
91+
```
92+
📦 DialogWeaver
93+
├─ 📂 .github # GitHub configurations and automation
94+
│ ├─ 📂 ISSUE_TEMPLATE # Templates for reporting issues (bugs, features)
95+
│ └─ 📂 workflows # GitHub Actions workflows (CI/CD, automated tests)
96+
97+
├─ 📂 api # Backend API service
98+
│ ├─ 📂 alembic # Database migration scripts (versioned)
99+
│ ├─ 📂 app # Core API logic (routes, controllers, models)
100+
│ ├─ 📂 tests # Unit & integration tests for API
101+
│ ├─ 📄 Dockerfile # Dockerfile to containerize the API
102+
│ ├─ 📄 alembic.ini # Alembic config for database migrations
103+
│ ├─ 📄 main.py # API server entry point
104+
│ └─ 📄 requirements.txt # Python dependencies for API
105+
106+
├─ 📂 docs # Documentation and images
107+
│ ├─ 📄 Architecture.png # Project architecture diagram
108+
│ ├─ 📄 gssoc.png # GSSoC-related image
109+
│ └─ 📄 logo.jpg # Project logo
110+
111+
├─ 📂 engine # Core engine/service module
112+
│ ├─ 📂 openvoiceos_engine # Main engine logic for OpenVoiceOS
113+
│ ├─ 📂 telephony_server # Telephony server logic (SIP, VoIP, calls)
114+
│ ├─ 📄 Dockerfile # Dockerfile to containerize engine service
115+
│ ├─ 📄 main.py # Engine service entry point
116+
│ └─ 📄 requirements.txt # Python dependencies for engine
117+
118+
├─ 📄 .env.sample # Sample environment variables template
119+
├─ 📄 .gitignore # Git ignore rules
120+
├─ 📄 CONTRIBUTING.md # Guidelines for contributors
121+
├─ 📄 LICENSE # Project license
122+
├─ 📄 README.md # Project documentation
123+
└─ 📄 docker-compose.yml # Docker Compose config for multi-service setup
124+
125+
```
90126

91127
## Quick Start
92128

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

149185

150186

187+
188+

0 commit comments

Comments
 (0)