2aea1af361
Completes Day 2 of the v1.0.3 → v1.0.4 cleanup sprint. The documentation now describes the actual repo layout instead of a fictional one. CLAUDE.md — complete rewrite Old version referenced paths that don't exist and a protocol aimed at implementing v0.11.0 (current tag: v1.0.3). The agent was following a map for a city that had been rebuilt. - backend/ → veza-backend-api/ - frontend/ → apps/web/ - ORIGIN/ (root) → veza-docs/ORIGIN/ - veza-chat-server → merged into backend-api (v0.502, commit279a10d31) - apps/desktop/ → never existed Also refreshed: stack versions (Go 1.25, Vite 5, React 18.2, Axum 0.8), commands, conventions, hook bypasses (SKIP_TYPES/SKIP_TESTS/SKIP_E2E), scope rules kept as immutable (no AI/ML, no Web3, no gamification, no dark patterns, no public popularity metrics). README.md — targeted fixes - "Version cible: v0.101" → "Version courante: v1.0.4" - "Development Setup (v0.9.3)" → "Development Setup" - Removed Desktop (Electron) section — never implemented - Removed veza-chat-server from structure — merged into backend - Removed deprecated compose files section (nothing is DEPRECATED now) k8s runbooks — remove stale chat-server references The disaster-recovery runbooks still scaled/restarted a deployment that no longer exists. In a real failover these commands would have failed silently and blocked the procedure. Files patched: - k8s/disaster-recovery/runbooks/cluster-failover.md - k8s/disaster-recovery/runbooks/data-restore.md - k8s/disaster-recovery/runbooks/database-failover.md - k8s/disaster-recovery/runbooks/rollback-procedure.md - k8s/network-policies/README.md - k8s/secrets/README.md - k8s/secrets.yaml.example Each reference is replaced by a short inline note pointing to v0.502 (commit279a10d31) so future readers understand the history. .env.example — remove CHAT_JWT_SECRET Legacy env var for the deleted chat server. Replaced by an explanatory comment. Not in this commit (user handles on Forgejo): - Closing the 5 open dependabot PRs on veza-chat-server/* branches - Deleting those 5 remote branches after the PRs are closed Refs: AUDIT_REPORT.md §5.1, §7.1, §10 P1, §10 P4
70 lines
2.3 KiB
Markdown
70 lines
2.3 KiB
Markdown
# Veza Monorepo
|
|
|
|
[](https://github.com/okinrev/veza/actions/workflows/ci.yml)
|
|
|
|
**Version courante** : v1.0.4 (cleanup + consolidation post-audit). Voir [CHANGELOG.md](CHANGELOG.md) et [docs/PROJECT_STATE.md](docs/PROJECT_STATE.md).
|
|
|
|
## Project Structure
|
|
|
|
- **`apps/web`** — Frontend React 18 + Vite 5 + TypeScript strict (source of truth for the UI)
|
|
- **`veza-backend-api`** — Main Go 1.25 API service (Gin, GORM, Postgres, Redis, RabbitMQ, Elasticsearch). Handles REST, WebSocket, and chat (chat server was merged into this service in v0.502).
|
|
- **`veza-stream-server`** — Rust streaming server (Axum 0.8, Tokio 1.35, Symphonia) — HLS, HTTP Range, WebSocket, gRPC
|
|
- **`veza-common`** — Shared Rust types and logging
|
|
- **`packages/design-system`** — Shared design tokens
|
|
|
|
See [CLAUDE.md](CLAUDE.md) for the full architecture map.
|
|
|
|
## Development Setup
|
|
|
|
Prerequisites: Node 20 (see `.nvmrc`), Go, Rust, Docker. Configure `.env` from `.env.example`.
|
|
|
|
```bash
|
|
# Verify environment
|
|
make doctor
|
|
./scripts/validate-env.sh development
|
|
|
|
# Install dependencies
|
|
make install-deps
|
|
|
|
# Option A — Backend in Docker + Web local
|
|
make dev
|
|
|
|
# Option B — All apps local with hot reload (infra from docker-compose.dev.yml)
|
|
make dev-full
|
|
|
|
# Option C — Infra only, then run services manually
|
|
docker compose -f docker-compose.dev.yml up -d
|
|
make dev-web # or make dev-backend-api, make dev-stream-server
|
|
```
|
|
|
|
See [docs/ENV_VARIABLES.md](docs/ENV_VARIABLES.md) for required variables. `make build` builds all services.
|
|
|
|
## Quick Start
|
|
|
|
### Frontend only
|
|
|
|
```bash
|
|
cd apps/web
|
|
npm install
|
|
npm run dev
|
|
```
|
|
|
|
## Docker Production
|
|
|
|
**Canonical production compose file**: `docker-compose.prod.yml`
|
|
|
|
```bash
|
|
docker compose -f docker-compose.prod.yml up -d
|
|
```
|
|
|
|
See `make/config.mk` for COMPOSE_PROD and deployment docs.
|
|
|
|
## CI/CD
|
|
|
|
- **Badge** : CI status above. Set `SLACK_WEBHOOK_URL` (Incoming Webhook) in repo secrets to receive Slack notifications on failure.
|
|
|
|
## Documentation
|
|
|
|
- **[Developer Onboarding](docs/ONBOARDING.md)** — Setup, architecture, conventions, troubleshooting
|
|
- **[Documentation index](docs/README.md)** — Index complet de la documentation
|
|
- See `docs/` for detailed architecture and development guides. Older audits and reports are archived in `docs/archive/`.
|