Files
crosscode-platform/README.md
T
joshuaandClaude Opus 5.5 19f79dfb17 Monorepo set up: workspaces, contracts package, placeholders
npm workspaces (packages/*, apps/*) with shared TypeScript, ESLint and
Jest setup and `npm run check`. @crosscode/contracts builds to CommonJS
and ESM (tsup) with the crosscode.<name>/<major> schema-name helpers.
packages/ui and apps/{accounts,website,app} are placeholders.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-04 09:36:42 +02:00

44 lines
1.9 KiB
Markdown

# Cross Code platform
The monorepo for the Cross Code products that come after Cross Events, and the formats they share.
The plan is in `hope-events/docs/ROADMAP-v3.md` (decided 2026-11-03).
| Folder | What | Status |
|--------|------|--------|
| `packages/contracts` | `@crosscode/contracts`: the shared JSON formats (zod schemas, JSON Schema, TypeScript types, sample payloads) used by every product, including Cross Events and the Hub | Phase 0, in progress |
| `packages/ui` | `@crosscode/ui`: shared UI for the Website, App and Accounts | Placeholder, filled in during the Website phase |
| `apps/accounts` | Accounts: the per-church sign-in (OpenID Connect) | Placeholder (phase 3) |
| `apps/website` | Church Website | Placeholder (phase 4) |
| `apps/app` | Church App (PWA) | Placeholder (phase 6) |
Cross Events (`joshua/hope-events`) and Cross Code Hub (`joshua/events-hub`) stay in their own
repos and install `@crosscode/contracts` from Gitea's package registry.
## Rules (ROADMAP-v3 §1)
1. No shared databases, ever. Products only talk over HTTPS using the contracts.
2. The Hub is never on the runtime path.
3. One maintained codebase per product. Nothing is built specially for one church.
4. The origin of a record owns it. Copies elsewhere are read-only and link back to the origin.
## Working on it
Node 20 or newer, npm workspaces.
```bash
npm install
npm run check # lint + typecheck + tests + build, for every workspace
npm run build # build every workspace
npm test # test every workspace
```
Work in a workspace with `npm run <script> -w packages/contracts`.
Stack (ROADMAP-v3 §8): TypeScript, zod, Jest, ESLint here; the apps add Next.js, Express,
Prisma, PostgreSQL and pg-boss, as in Cross Events. PM2 and nginx, no Docker.
## Releasing
Each package and app is versioned and tagged on its own, as `<name>@<version>` (e.g.
`contracts@1.0.0`). Branch → merge → tag → push, with a CHANGELOG entry. Run `npm run check` first.