Vlad Durnea
cd124f7d4a
add wiki/ markdown pages (Home, Sidebar, architecture, transport, developer, usage) add scripts/publish_gitea_wiki.sh to sync wiki repo fix: serialize aggregate env-setting tests to avoid parallel env var races
43 lines
1.2 KiB
Markdown
43 lines
1.2 KiB
Markdown
# cloudlysis (monorepo)
|
|
|
|
## Layout
|
|
- Rust services (Cargo workspace): `aggregate/`, `gateway/`, `projection/`, `runner/`, `control/api/`, `shared/`
|
|
- Control UI: `control/ui/`
|
|
- Docker + Swarm + Compose: `docker/`, `docker-compose.yml`, `swarm/`, `observability/`
|
|
|
|
## Documentation
|
|
- docs/README.md
|
|
- Architecture: docs/architecture/overview.md, docs/architecture/transport.md
|
|
- Developer: docs/developer/setup.md, docs/developer/testing.md
|
|
- Usage: docs/usage/quickstart.md, docs/usage/api.md, docs/usage/nats.md
|
|
- Gitea Wiki: run `scripts/publish_gitea_wiki.sh` (publishes `wiki/` to the repo wiki)
|
|
|
|
## Quick Start (Docker Compose)
|
|
|
|
```bash
|
|
docker compose up -d --build
|
|
```
|
|
|
|
Full local stack with observability:
|
|
|
|
```bash
|
|
docker compose -f docker-compose.yml -f observability/docker-compose.yml up -d --build
|
|
```
|
|
|
|
## Commands
|
|
- `make compose-up`, `make compose-down`
|
|
- `make compose-up-observability`, `make compose-down-observability`
|
|
- `make docker-build-all`
|
|
- `make swarm-deploy-all`, `make swarm-rm-all`
|
|
|
|
More details: `DOCKER.md`
|
|
|
|
## Workspace Verification
|
|
|
|
```bash
|
|
cargo fmt --check
|
|
cargo clippy --workspace --all-targets -- -D warnings
|
|
cargo test --workspace
|
|
cd control/ui && npm ci && npm run lint && npm run typecheck && npm run test && npm run build
|
|
```
|