Files
ZitPlane/README.md
T

40 lines
1.8 KiB
Markdown

# ZitPlane
A compact, developer-friendly monorepo for central identity, branded sign-in, and account self-service.
**Status:** Phase 01 — repository foundation only. No backend, login app, account portal, or Docker stack has been installed yet.
## Planned components
| Path | Responsibility |
| --- | --- |
| `core/backend/zitadel/` | Version-pinned official ZITADEL backend configuration; **not** a copy of its Go source |
| `auth/ui/v2/` | Customizable official Login V2 frontend, with required upstream build dependencies |
| `users/ui/` | Separate account management portal |
| `packages/` | Shared UI and generated/API clients, only when actually needed |
| `deployment/` | Compose, reverse proxy, deployment configuration |
| `scripts/` | Simple documented local developer entrypoints |
| `tests/` | Focused integration and UI regression tests |
| `docs/` | Architecture, development guide, phase scopes |
## Planned domains
- `auth.vib.tools` — ZITADEL OIDC/API, sign-in UI, built-in management console.
- `account.vib.tools` — customer self-service account portal.
These domains are design targets; they are **not deployed or configured yet**.
## Ground rules
- One Git repository, multiple isolated Docker services at runtime.
- ZITADEL stays upstream and version-pinned; no fork of its Go backend is planned.
- Dev/prod data and credentials stay separate. No secrets in Git.
- ZITADEL handles identity; individual SaaS products handle plans, billing and product data.
- One approved, scope-locked phase at a time. See [phases](docs/PHASES.md) and [agent rules](AGENTS.md).
## Start here
1. Read [architecture](docs/ARCHITECTURE.md) and [development](docs/DEVELOPMENT.md).
2. Approve Phase 02 before adding ZITADEL or any Docker startup configuration.
3. Do not run an application from this foundation-only scaffold; none has been installed.