madava/avaaz
1
0
Fork 0
Code Pull Requests Actions Releases Activity

Update documentation
All checks were successful
Continuous Integration / Validate and test changes (push) Successful in 3s
Details

Browse Source
This commit is contained in:
Madava
2025-12-03 01:28:28 +01:00
parent 1423a4e4b2
commit 73fd4d26a5
8 changed files with 58 additions and 29 deletions
Download Patch File Download Diff File Expand all files Collapse all files

0
docs/PRD.md Normal file
View File

6
docs/architecture.md
View File

@@ -115,7 +115,7 @@ flowchart LR
#### Infra Stack
Docker Compose from the `avaaz-infra` Git repository is cloned to `/srv/infra/docker-compose.yml` on the VPS.
Docker Compose from `./infra/docker-compose.yml` is cloned to `/srv/infra/docker-compose.yml` on the VPS.
| Container | Description |
| -------------- | ----------------------------------------------------------------------------------- |
@@ -125,7 +125,7 @@ Docker Compose from the `avaaz-infra` Git repository is cloned to `/srv/infra/do
#### App Stack
Docker Compose from the `avaaz-app` Git repository is cloned to `/srv/app/docker-compose.yml` on the VPS.
Docker Compose from `./app/docker-compose.yml` is cloned to `/srv/app/docker-compose.yml` on the VPS.
| Container | Description |
| ---------- | ----------------------------------------------------------------------------------------- |
@@ -134,7 +134,7 @@ Docker Compose from the `avaaz-app` Git repository is cloned to `/srv/app/docker
| `postgres` | **PostgreSQL + pgvector** – Persistent relational database with vector search. |
| `livekit` | **LiveKit Server** – WebRTC signaling plus UDP media for real-time audio and data. |
The `backend` uses several Python packages such as UV, Ruff, FastAPI, FastAPI Users, FastAPI-pagination, FastStream, Pydantic, PydanticAI, Pydantic-settings, LiveKit Agent, Google Gemini Live API, OpenAI Realtime API, SQLAlchemy, Alembic, docling, Gunicorn, Uvicorn[standard], Pyright, Pytest, Hypothesis, and Httpx to deliver the services.
The `backend` uses several Python packages such as UV, Ruff, FastAPI, FastAPI Users, FastAPI-pagination, FastStream, FastMCP, Pydantic, PydanticAI, Pydantic-settings, LiveKit Agent, Google Gemini Live API, OpenAI Realtime API, SQLAlchemy, Alembic, docling, Gunicorn, Uvicorn[standard], Pyright, Pytest, Hypothesis, and Httpx to deliver the services.
### 1.2 Network

1
docs/docker.md
View File

@@ -9,6 +9,7 @@ The following command will delete ALL Docker data, including stopped containers,
```bash
cd /srv/infra
sudo docker stop $(sudo docker ps -a -q) && sudo docker rm $(sudo docker ps -a -q)
sudo docker compose down -v --rmi all --remove-orphans
```

6
docs/git.md
View File

@@ -8,7 +8,7 @@
## Pull Request
1. Ensure your main branch is protected, so that direct push is disabled.
1. Ensure your main branch is protected on Gitea configuration, so that direct push is disabled.
2. Update the local main branch.
@@ -69,10 +69,10 @@
git push origin --delete feature/new-branch
```
13. Create a new branch for upcoming work, for example `feature/dev`.
13. Create a new branch for upcoming work, for example `feature/new-branch-2`.
```bash
git checkout -b feature/dev
git checkout -b feature/new-branch-2
```
## Troubleshooting

0
docs/plan.md Normal file
View File