Yabanin — Panduan Pembangunan
Prasyarat
- Go 1.27+ (
go versionpatut melaporkango1.27.xatau lebih baharu; modul dibina dengan bersih pada 1.27) - Docker dengan Docker Compose v2
make(dibekalkan bersama Xcode Command Line Tools pada macOS)psql— pilihan, diperlukan hanya untuk larian migrasi tempatan di luar Docker
Permulaan pantas
# 1. Copy the environment template
cp .env.example .env # edit if you need non-default values
# 2. Bring up Postgres, Redis, and all three services
make docker-up
# 3. Run the smoke test (starts infra if not running, checks health)
bash scripts/smoke_test.sh
# 4. Tear everything down
make docker-down
Selepas docker-up perkhidmatan tersedia di:
| Perkhidmatan | Alamat dengar (kontena) | Hos (compose) | Kesihatan |
|---|---|---|---|
| gerbang | :8082 | 8082 | /healthz |
| admin/metrik gerbang | :9090 | 9090 | — |
| satah kawalan admin | :8086 | 9091 | /health |
| loggerd | :8085 | 8085 | /healthz |
| mcp SSE | :8787 | — (helm sahaja) | — |
Struktur projek
.
├── services/ # Service binaries (each is its own package)
│ ├── gateway/cmd/main.go # Reverse-proxy / API router (data-plane)
│ ├── loggerd/cmd/main.go # Redis stream consumer → Postgres writer
│ └── admin/cmd/main.go # Admin panel + CRUD APIs (control-plane)
├── pkg/ # Shared library packages
│ ├── config/ # YAML config loading + env-var resolution
│ ├── auth/ # API key & session authentication
│ ├── adminauth/ # Admin-specific HMAC cookie auth
│ ├── adminstore/ # Admin user store (Postgres)
│ ├── rulestore/ # Routing rules CRUD store
│ ├── evaluator/ # Rule matching engine
│ ├── openai/ # OpenAI API request/response types
│ ├── resolver/ # Model routing resolution
│ ├── redisutil/ # Redis client wrapper
│ ├── log/ # Structured logging (slog)
│ ├── logging/ # Logrus bridge / formatting
│ ├── events/ # Event payload types
│ ├── eventpublisher/ # Redis stream publisher interface
│ ├── cli/ # Service lifecycle helpers