Files
ZitPlane/README.md
T

41 lines
2.1 KiB
Markdown
Raw Normal View History

# ZitPlane
Compact, developer-friendly monorepo for a central identity service, a branded login frontend and an independent user self-service account portal.
## Current phase status
- **P01 Foundation:** complete, initial commit `8f54ccb`.
- **P02 ZITADEL local backend:** pinned official images, development Compose, secure local bootstrap helper and focused static tests implemented. **Docker startup and Admin Console integration remain unverified** because the connected Windows PC has no Docker CLI.
- **P03 Login V2 source / P04 Account Portal:** not started.
- **Production / Coolify:** not configured or deployed.
## Responsibility map
| Path | Purpose |
| --- | --- |
| `core/backend/zitadel/` | Official ZITADEL backend integration and local helper |
| `deployment/docker/compose.backend.dev.yaml` | Loopback-only developer stack |
| `auth/ui/v2/` | Future customized official Login V2 source (P03) |
| `users/ui/` | Future account self-service portal (P04) |
| `packages/` | Shared packages only when needed |
| `tests/` | Focused contracts and future integration/UI tests |
| `docs/` | Architecture, scopes and developer instructions |
## Local development (requires Docker Desktop Linux containers)
```powershell
py core/backend/zitadel/dev.py init
py core/backend/zitadel/dev.py config
py core/backend/zitadel/dev.py up
```
When the backend stack is actually running, the local Admin Console is expected at `http://localhost:8080/ui/console`. This is **not** a currently verified working URL. See [backend setup](core/backend/zitadel/README.md) and [developer guide](docs/DEVELOPMENT.md).
## Intended public architecture (not deployed)
- `auth.vib.tools`: eventual ZITADEL API, official Console, customized login.
- `account.vib.tools`: future custom account portal.
- Individual SaaS applications own their own billing, subscriptions and business databases.
- One Git repo, isolated containers; ZITADEL Go source remains upstream.
## Working agreements
Read [AGENTS.md](AGENTS.md), [architecture](docs/ARCHITECTURE.md) and [phase scopes](docs/PHASES.md). Use separate, expressly approved phases; no production secrets or user data in Git.