Files

53 lines
3.6 KiB
Markdown

# ZitPlane Login UI V2 — Upstream Source Workspace
**Status:** P03 source imported; **not built, tested, launched, or connected to the P02 Compose service**. No UI redesign has been performed.
This folder is a self-contained **source workspace**, not a single standalone app. Its files were copied from the official `zitadel/zitadel` release tag **v4.20.4**, Git revision **384bb9ec96b501ad39dc232ee2061a40fe180bbd**, matching the pinned P02 backend image.
## Start here (beginner-friendly)
| What you want to change | Where to look |
| --- | --- |
| Login / signup / recovery / verification pages | `apps/login/src/app/` |
| Buttons, forms, field styles and reusable UI | `apps/login/src/components/` |
| Global CSS / theme | `apps/login/src/styles/` |
| Images, icons, static assets | `apps/login/public/` |
| Language translations | `apps/login/locales/` |
| Browser/OIDC auth code (protected) | `apps/login/src/lib/` and `apps/login/src/proxy.ts` |
| API client and auth transport (protected) | `packages/zitadel-client/` |
| Generated API types (do not hand-edit) | `packages/zitadel-proto/` and `proto/` |
| Tooling and pinned dependency graph | `package.json`, `pnpm-workspace.yaml`, `pnpm-lock.yaml`, `nx.json` |
App source is at **`auth/ui/v2/apps/login/`**, not directly under `auth/ui/v2/src`. This deliberately preserves the upstream workspace layout, so Next.js/Nx/proto imports are easier to maintain.
## Local/CI workflow — commands are DOCUMENTED ONLY (not executed in P03)
From the **`auth/ui/v2`** folder after the development environment is available:
```sh
corepack enable
pnpm install --frozen-lockfile
pnpm nx run @zitadel/proto:generate
pnpm nx run @zitadel/client:build
pnpm nx run @zitadel/login:build
```
The partial upstream workspace has the **original full-monorepo lockfile**. A CI phase must confirm if frozen installation works with these retained importers. If it does not, reconcile the lockfile with a separately approved dependency-only change and pin the revised artifact before calling the source reproducible. **Do not silently run plain `pnpm install` or auto-upgrade packages.**
Required environment values, such as `ZITADEL_API_URL` and a dedicated Login Client PAT, must be supplied **only at runtime in secure, ignored local files or CI secrets**. No credentials or real tokens are stored here. The upstream tracked `apps/login/.env` and `apps/login/.env.prod` were intentionally **not imported** to avoid confusing dev/prod config; follow the ZITADEL docs when wiring environment values. The upstream `apps/login/.env.theme.example` remains as a safe design reference.
## Scope and update rules
- Edit **visual-only** components, CSS, icons and copy only after P06 is explicitly approved.
- Do **not** change OIDC, MFA, SSO, server actions, routing, token handling, passkey, cookies or session logic as a side effect of visual work.
- P03 does **not** replace `zitadel-login` in the P02 Docker Compose; P05 will wire the customized image after CI checks.
- This source is an import snapshot. Updating it requires selecting a new official release, reading release notes, importing the whole dependency closure from the same revision, and running future CI verification.
- The upstream Login app and the client/proto TypeScript packages are MIT-licensed; upstream `proto/` is Apache-2.0; root build/config and other files may have different licensing. See upstream `LICENSING.md` and `LICENSE` included here.
## Provenance and details
Read [P03 Source Import Evidence](../../../docs/P03-SOURCE-IMPORT.md).
Official docs: https://zitadel.com/docs/guides/integrate/login-ui/fork-and-deploy-login-app
Official revision: https://github.com/zitadel/zitadel/tree/v4.20.4