Files
ZitPlane/README.md
T

58 lines
4.9 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 and secure local bootstrap helper source prepared. **Docker startup and Admin Console integration remain unverified**; all follow-up local testing is explicitly deferred to a future Gitea Actions scope.
- **P03 Login V2 source:** official v4.20.4 source and matching client/proto workspace imported under `auth/ui/v2/`; no redesign or runtime build/test was performed. **CI validation remains pending.**
- **P04 Account Portal:** Next.js + ZITADEL OIDC Auth.js source, server-protected overview/profile/security pages and compact responsive foundation implemented under `users/ui/`. **No build/test/runtime validation yet; future Gitea Actions required.**
- **P05-CI-01:** Manual Gitea Run #81 **overall FAILURE**: Login V2 build + 1219 unit tests PASS, high/critical gate PASS (18 Moderate Login findings), Account Auth.js TS2345 and Docker checkout FAIL. Details: `docs/P05-CI-01.md`.
- **P05-CI-02:** Gitea Run #83 **3 PASS / 1 FAIL**. Account Portal typecheck/build and negative identity checks PASS; Login V2 build + 1219/1219 tests PASS; High/Critical security threshold PASS (18 Moderate Login records + 1 Moderate Account package OPEN). Docker Postgres/ZITADEL API/Login healthy, but shared runner port 8080 blocked Traefik; cleanup PASS. CI-only portless override added afterward **not CI-verified**; full OIDC E2E deferred. See `docs/P05-CI-02.md`.
- **P05-CI-03:** Dedicated backend-only Gitea Actions verification for portless Compose, PostgreSQL restart persistence, ZITADEL ready/OIDC discovery and safe cleanup. **Source prepared; CI acceptance pending.** Existing Account/Login build suites are not rerun.
- **Production / Coolify:** not configured or deployed.
## Documentation and project knowledge
ZitPlane uses three **Git-tracked Markdown areas**. For every future feature, change or fix, create the plan **before editing code** and update all affected documentation in the same phase:
| Folder | Who reads it | What's inside |
| --- | --- | --- |
| [`notes/`](notes/README.md) | Developers / AI agents during work | Scope locks, pre-change plans, phase/fix logs, decisions, verification outcomes |
| [`project/`](project/README.md) | Maintainers / developers / AI agents | Real file/function map, feature/page details, architecture, modules, dependencies, change history and full source index |
| [`docs/`](docs/README.md) | End users / operators / developers | Page and button usage, onboarding, status, setup steps, troubleshooting and known limitations |
Each of these folders contains `README.md` and the requested literal `MINIFEST.md` (direct-child list, purpose, phase and status). The root [MINIFEST.md](MINIFEST.md) indexes top-level content. Rules are mandatory in [AGENTS.md](AGENTS.md). Imported official Login V2 source remains untouched.
## 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/` | Official Login V2 monorepo subset (Next.js source in `apps/login/`, matched client/proto and pnpm/Nx workspace) |
| `users/ui/` | P04 account portal source: separate Next.js app, protected pages, OIDC, server-side user API (CI pending) |
| `packages/` | Shared packages only when needed |
| `tests/` | Focused P02 contracts and P05 isolated CI smoke scripts |
| `.gitea/` | Gitea Actions manual CI verification configuration |
| `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), [P03 source import](docs/P03-SOURCE-IMPORT.md), [Login V2 workspace guide](auth/ui/v2/README.md), [P04 account evidence](docs/P04-ACCOUNT-PORTAL.md), [Account Portal guide](users/ui/README.md) and [phase scopes](docs/PHASES.md). Use separate, expressly approved phases; no production secrets or user data in Git.