Files
ZitPlane/README.md
T

3.9 KiB

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.
  • 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/ Developers / AI agents during work Scope locks, pre-change plans, phase/fix logs, decisions, verification outcomes
project/ Maintainers / developers / AI agents Real file/function map, feature/page details, architecture, modules, dependencies, change history and full source index
docs/ 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 indexes top-level content. Rules are mandatory in 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 contracts and future integration/UI tests
docs/ Architecture, scopes and developer instructions

Local development (requires Docker Desktop Linux containers)

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 and developer guide.

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, architecture, P03 source import, Login V2 workspace guide, P04 account evidence, Account Portal guide and phase scopes. Use separate, expressly approved phases; no production secrets or user data in Git.