Files
nroxy/README.md

32 lines
1.2 KiB
Markdown

# nproxy
Planning scaffold for a crypto-subscription image gateway.
The repository is intentionally light on runtime code. Its current purpose is to store:
- the agreed MVP plan;
- the repository layout for future implementation;
- operational notes for deployment, Telegram pairing, and provider key rotation;
- directory-scoped instructions so future Codex runs can 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/mvp-system-plan.md`
- `docs/architecture/system-overview.md`
- `docs/ops/deployment.md`
- `CONTRIBUTING.md`