55 lines
2.7 KiB
Markdown
55 lines
2.7 KiB
Markdown
# Cross Code platform
|
|
|
|
The monorepo for the Cross Code products that come after Cross Events, and the formats they share.
|
|
The plan for every product is in [`docs/ROADMAP-v3.md`](./docs/ROADMAP-v3.md) (decided 2026-11-03); where
|
|
things stand is in [`docs/HANDOVER.md`](./docs/HANDOVER.md).
|
|
|
|
| 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`) moves in as `apps/events` in Events 2.2.0
|
|
([`docs/EVENTS-2.2-PLAN.md`](./docs/EVENTS-2.2-PLAN.md)). Cross Code Hub (`joshua/events-hub`) stays in
|
|
its own repo and gets `@crosscode/contracts` as a packed release committed there (decision 22).
|
|
|
|
## Docs
|
|
|
|
| File | What |
|
|
|------|------|
|
|
| [`docs/ROADMAP-v3.md`](./docs/ROADMAP-v3.md) | The plan: products, contracts, Accounts, sync, Hub, servers, build order, pricing, decisions |
|
|
| [`docs/HANDOVER.md`](./docs/HANDOVER.md) | Where each phase stands and what's next |
|
|
| [`docs/hub-protocol.md`](./docs/hub-protocol.md) | Install ↔ Hub protocol, versions 1 and 2 (a copy lives in `events-hub`) |
|
|
| [`docs/EVENTS-2.2-PLAN.md`](./docs/EVENTS-2.2-PLAN.md) | Phase 1b: Cross Events into the monorepo, the `crosscode` script |
|
|
|
|
## 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.
|