32 lines
1.1 KiB
Markdown
32 lines
1.1 KiB
Markdown
# nproxy
|
|
|
|
Product codebase for a crypto-subscription image gateway.
|
|
|
|
The repository contains:
|
|
- runtime applications and shared packages;
|
|
- the agreed system plan and architecture documents;
|
|
- operational notes for deployment, Telegram pairing, and provider key rotation;
|
|
- directory-scoped instructions so Codex runs implement against the same decisions.
|
|
|
|
## Chosen baseline
|
|
- Product: B2C website
|
|
- Billing: one monthly plan, paid with crypto through a payment processor
|
|
- Model support: starts with `nano_banana`
|
|
- Generation modes: text-to-image and image-to-image
|
|
- Infra target: one VPS with Docker Compose
|
|
- Admin surfaces: web admin and Telegram bot
|
|
- Key management: multiple provider keys with round-robin routing, failover, cooldown, balance tracking, and optional per-key proxy
|
|
|
|
## Main directories
|
|
- `apps/` runtime entrypoints
|
|
- `packages/` shared domain and adapter code
|
|
- `docs/` source-of-truth planning documents
|
|
- `infra/` deployment templates
|
|
- `scripts/` operational helpers
|
|
|
|
## Read first
|
|
- `docs/plan/system-plan.md`
|
|
- `docs/architecture/system-overview.md`
|
|
- `docs/ops/deployment.md`
|
|
- `CONTRIBUTING.md`
|