From ca338cb0171f716d9a9132b9cd8619774968efe6 Mon Sep 17 00:00:00 2001 From: adilallo <39313955+adilallo@users.noreply.github.com> Date: Sat, 23 May 2026 15:10:49 -0600 Subject: [PATCH 1/3] Add staging smoke script for Cloudron install --- docs/guides/ops-backend-deploy.md | 4 ++ scripts/staging-smoke.sh | 97 +++++++++++++++++++++++++++++++ 2 files changed, 101 insertions(+) create mode 100755 scripts/staging-smoke.sh diff --git a/docs/guides/ops-backend-deploy.md b/docs/guides/ops-backend-deploy.md index 4025373..0b571ea 100644 --- a/docs/guides/ops-backend-deploy.md +++ b/docs/guides/ops-backend-deploy.md @@ -388,6 +388,10 @@ production env vars, and verify the vertical slice before apex cutover **Smoke checklist (acceptance):** +Automated curl checks: `./scripts/staging-smoke.sh staging.communityrule.info` +(optional `EMAIL=you@example.com` to exercise magic-link request). Manual UI +steps below are still required. + - [ ] **Health:** `curl -sS https://staging.communityrule.info/api/health` returns `200` with `{"ok":true,"database":"connected"}`. - [ ] **Magic link:** request sign-in from the UI → email arrives at a real diff --git a/scripts/staging-smoke.sh b/scripts/staging-smoke.sh new file mode 100755 index 0000000..ee0d268 --- /dev/null +++ b/scripts/staging-smoke.sh @@ -0,0 +1,97 @@ +#!/bin/sh +# Staging / production smoke. Verifies CR-98 acceptance criteria (curl-able checks). +# See docs/guides/ops-backend-deploy.md §10. +# +# Usage: +# ./scripts/staging-smoke.sh +# ./scripts/staging-smoke.sh communityrule.info +# EMAIL=you@example.com ./scripts/staging-smoke.sh staging.communityrule.info +# +# Manual follow-up (not automated here): click magic link in inbox, publish a rule, +# optional upload with UPLOAD_ROOT set. + +set -eu + +HOST="${1:-staging.communityrule.info}" +BASE="https://${HOST}" +FAIL=0 + +pass() { + printf 'PASS %s\n' "$1" +} + +fail() { + printf 'FAIL %s\n' "$1" + FAIL=1 +} + +check_http() { + name="$1" + url="$2" + expected_status="$3" + + status="$(curl -sS -o /tmp/staging-smoke-body.$$ -w '%{http_code}' "$url" || echo '000')" + if [ "$status" = "$expected_status" ]; then + pass "$name (HTTP $status)" + else + fail "$name (expected HTTP $expected_status, got $status)" + if [ -f "/tmp/staging-smoke-body.$$" ]; then + head -c 500 "/tmp/staging-smoke-body.$$" 1>&2 || true + printf '\n' 1>&2 + fi + fi +} + +check_json_contains() { + name="$1" + pattern="$2" + if grep -q "$pattern" "/tmp/staging-smoke-body.$$" 2>/dev/null; then + pass "$name" + else + fail "$name (body missing pattern: $pattern)" + head -c 500 "/tmp/staging-smoke-body.$$" 1>&2 || true + printf '\n' 1>&2 + fi +} + +printf 'Smoke target: %s\n\n' "$BASE" + +check_http "GET /api/health" "$BASE/api/health" "200" +check_json_contains 'health ok + database connected' '"ok":true' +check_json_contains 'health database connected' '"database":"connected"' + +check_http "GET /api/templates" "$BASE/api/templates" "200" +check_json_contains 'templates non-empty' '"templates":[' + +check_http "GET /api/rules" "$BASE/api/rules" "200" +check_json_contains 'rules list shape' '"rules":[' + +if [ -n "${EMAIL:-}" ]; then + status="$(curl -sS -o /tmp/staging-smoke-body.$$ -w '%{http_code}' \ + -X POST "$BASE/api/auth/magic-link/request" \ + -H 'Content-Type: application/json' \ + -d "{\"email\":\"$EMAIL\"}" || echo '000')" + if [ "$status" = "200" ]; then + check_json_contains 'magic-link request ok' '"ok":true' + pass "POST /api/auth/magic-link/request (HTTP 200)" + printf ' Check inbox for %s — link host must be %s\n' "$EMAIL" "$HOST" + else + fail "POST /api/auth/magic-link/request (expected HTTP 200, got $status)" + head -c 500 "/tmp/staging-smoke-body.$$" 1>&2 || true + printf '\n' 1>&2 + fi +else + printf 'SKIP POST /api/auth/magic-link/request (set EMAIL= to run)\n' +fi + +rm -f "/tmp/staging-smoke-body.$$" + +printf '\n' +if [ "$FAIL" -eq 0 ]; then + printf 'All automated checks passed.\n' + printf 'Manual: click magic link, publish a rule, load public detail.\n' + exit 0 +fi + +printf 'One or more checks failed.\n' +exit 1 -- 2.43.0 From 98eed6cf22c27c5a57496d2a1f96667ff8c7708b Mon Sep 17 00:00:00 2001 From: adilallo <39313955+adilallo@users.noreply.github.com> Date: Sat, 23 May 2026 16:47:47 -0600 Subject: [PATCH 2/3] Update public documenation --- CONTRIBUTING.md | 207 +++++++++++++++++++++++++++++------------------- README.md | 66 +++++++++------ 2 files changed, 168 insertions(+), 105 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 57f71a0..6f0dce1 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,101 +1,148 @@ # Contributing -## Local backend +Thanks for working on Community Rule. This file covers local setup, the +API surface, and the pull-request workflow. Per-file implementation +conventions live in [`.cursor/rules/`](.cursor/rules/) (auto-loaded by +Cursor); high-level orientation is in [`AGENTS.md`](AGENTS.md). -1. Copy [`.env.example`](.env.example) to `.env` and set `SESSION_SECRET` - (at least 16 characters). -2. `docker compose up -d postgres mailhog` — omit `mailhog` if you only - need Postgres. Without `CLOUDRON_MAIL_SMTP_*`, the **magic-link verify URL** is - printed in the dev server log. -3. `npm ci` -4. `npx prisma migrate dev` -5. *(Optional)* `npx prisma db seed` — seeds curated rule templates. - Idempotent; rows upsert by `slug`. -6. `npm run dev` +## Local setup -Use `npx prisma studio` to inspect the database. +Prerequisites: Node **20+**, npm **10+**, Docker. -Deploying to staging or production (MEDLab Cloudron) — see -[docs/guides/ops-backend-deploy.md](docs/guides/ops-backend-deploy.md) -for the admin handoff and the linked Linear tickets for the actual -deployment-pipeline work. +```bash +cp .env.example .env # set SESSION_SECRET (≥16 chars) +docker compose up -d postgres mailhog # omit `mailhog` if you don't need + # a local inbox +npm ci +npx prisma migrate dev +npx prisma db seed # optional — seeds curated templates +npm run dev +``` -### Prisma migrations +Open [http://localhost:3000](http://localhost:3000). Use +`npx prisma studio` to browse the database. -- **Never edit** a migration that has already been applied to staging, - production, or any shared database. Add a **new** migration that - corrects the schema instead. Full policy: - [docs/guides/backend-roadmap.md](docs/guides/backend-roadmap.md) §8. -- Any change under **`prisma/`**: run **`npm run migrate:smoke`** (see - [docs/testing-guide.md](docs/testing-guide.md#running-tests), **Prisma** - under *Running tests*). - -### API routes - -| Method | Path | Purpose | -| --- | --- | --- | -| GET | `/api/health` | Liveness / DB check. | -| GET | `/api/auth/session` | Current user or null. | -| POST | `/api/auth/magic-link/request` | Send sign-in link email. | -| GET | `/api/auth/magic-link/verify` | Validate token, set cookie, redirect. | -| POST | `/api/auth/logout` | Clear session. | -| GET / PUT | `/api/drafts/me` | Load or save the create-flow draft. | -| POST | `/api/uploads` | Authenticated multipart upload (create-flow images / PDFs); requires `UPLOAD_ROOT`. | -| GET | `/api/uploads/[id]` | Stream a previously uploaded file by opaque id (public read). | -| GET / POST | `/api/rules` | List or publish rules. | -| GET | `/api/templates` | List curated templates. Optional repeatable `facet.=` query params re-rank results (and may include `scores` in the JSON). See [docs/guides/template-recommendation-matrix.md](docs/guides/template-recommendation-matrix.md) §9.1. | -| GET | `/api/templates/[slug]` | Single curated template plus normalized `{ section, slug }` composition from `body`. Public read; 404 when unknown. §9.4 (CR-115). | -| GET | `/api/create-flow/methods` | Public catalog for built-in governance methods and core values. Required `section` (`communication` \| `membership` \| `decisionApproaches` \| `conflictManagement` \| `coreValues`; alias `values` → `coreValues`). Returns the **full deck** with `label`, `description`, and `sections` (methods) or `id`, `label`, `meaning`, `signals` (core values). Optional `facet.*` adds `matches` and re-ranks method rows (ignored for `coreValues`). Core value `id` is a 1-based position string (`"1"`, `"2"`, …). English v1 only. §9.2 / §9.5 (CR-115). | -| POST / GET | `/api/web-vitals` | Ingest or read web vitals. **Production default:** `external` — structured logs only (no writes under `.next`; safe for read-only FS). **Development default:** `local` — aggregates under `.next/web-vitals`. Override with `WEB_VITALS_STORAGE`. See [docs/guides/backend-roadmap.md](docs/guides/backend-roadmap.md) §7. | -| GET | `/api/rules/me` | Authenticated list of own published rules. | -| GET / PATCH / DELETE | `/api/rules/[id]` | Public read; owner update/delete. | -| POST | `/api/rules/[id]/duplicate` | Owner clone of a published rule. | -| GET / POST | `/api/rules/[id]/stakeholders` | List or invite rule stakeholders. | -| DELETE | `/api/rules/[id]/stakeholders/[stakeholderId]` | Remove a stakeholder. | -| POST | `/api/rules/[id]/stakeholders/[stakeholderId]/resend` | Resend stakeholder invite email. | -| GET | `/api/invites/rule-stakeholder/verify` | Verify stakeholder invite token; redirect. | -| DELETE | `/api/user/me` | Delete authenticated user account. | -| POST | `/api/user/email-change/request` | Request email change (magic link to new address). | -| GET | `/api/user/email-change/verify` | Verify email-change token; update `User.email`. | -| POST | `/api/organizer-inquiry` | Submit ask-organizer inquiry form. | -| POST | `/api/use-cases/[slug]/duplicate` | Duplicate a use-case demo rule. | +Deploying to staging or production (MEDLab Cloudron at `my.medlab.host`) +is documented in +[`docs/guides/ops-backend-deploy.md`](docs/guides/ops-backend-deploy.md). ### Magic-link sign-in -- Visit **[/login](http://localhost:3000/login)** or use **Log in** in the - site header. -- Without `CLOUDRON_MAIL_SMTP_*`: copy the verify URL from the dev server terminal. -- With Mailhog: set `CLOUDRON_MAIL_SMTP_SERVER=localhost` and - `CLOUDRON_MAIL_SMTP_PORT=1025` (see `.env.example`) and open the message - at [http://localhost:8025](http://localhost:8025). -- Open the link in the **same browser** as the app (session cookie). +1. Go to [/login](http://localhost:3000/login) or click **Log in** in + the site header. +2. Submit your email. +3. Open the verify link in the **same browser** (the session cookie is + bound to that origin): + - **Without SMTP:** copy the URL from the dev-server log. + - **With Mailhog:** open the message at + [http://localhost:8025](http://localhost:8025). -### Optional draft sync +### Prisma migrations -Postgres draft persistence via `PUT /api/drafts/me` is **on by default** for -signed-in users and post-sign-in transfer of anonymous drafts. Set -`NEXT_PUBLIC_ENABLE_BACKEND_SYNC=false` to disable server sync (anonymous -progress stays in `localStorage` only). +- **Never edit a migration** that has already been applied to staging, + production, or any shared database — add a new migration instead. + Full policy: [`docs/guides/backend-roadmap.md`](docs/guides/backend-roadmap.md) §8. +- **After any change under `prisma/`**, run `npm run migrate:smoke` + (Docker required). A throwaway Postgres on `127.0.0.1:5433` verifies + the migration applies cleanly. See + [`docs/testing-guide.md`](docs/testing-guide.md) → *Running tests*. + +### Draft persistence + +Signed-in create-flow drafts sync to Postgres via `PUT /api/drafts/me` +by default; anonymous progress stays in `localStorage`. Set +`NEXT_PUBLIC_ENABLE_BACKEND_SYNC=false` to disable server sync. ### Create flow The custom wizard lives under `/create/…`. Step order, URLs, and Figma -stage mapping are canon in [docs/create-flow.md](docs/create-flow.md). -Engineering tracking: Linear **CR-89** (**Done**) / -[docs/guides/backend-linear-tickets.md](docs/guides/backend-linear-tickets.md) -Ticket 17. +stage mapping are canon in +[`docs/create-flow.md`](docs/create-flow.md); component conventions are +in `.cursor/rules/create-flow.mdc`. -## Frontend & tests +## API routes -- Code conventions are enforced by `.cursor/rules/*.mdc` — Cursor surfaces - the relevant rule when editing matching files. -- See [docs/testing-guide.md](docs/testing-guide.md) for testing - philosophy and `.cursor/rules/testing.mdc` for layout/helpers. +All routes return JSON. Non-`GET` requests expect +`Content-Type: application/json` unless noted (uploads are multipart). -## Pull request workflow +### Auth & account + +| Method | Path | Purpose | +| --- | --- | --- | +| GET | `/api/health` | Liveness + DB connectivity. | +| GET | `/api/auth/session` | Current user or `null`. | +| POST | `/api/auth/magic-link/request` | Send sign-in link. | +| GET | `/api/auth/magic-link/verify` | Validate token, set cookie, redirect. | +| POST | `/api/auth/logout` | Clear session. | +| DELETE | `/api/user/me` | Delete authenticated account. | +| POST | `/api/user/email-change/request` | Send verify link to new address. | +| GET | `/api/user/email-change/verify` | Apply email change. | + +### Drafts & uploads + +| Method | Path | Purpose | +| --- | --- | --- | +| GET, PUT | `/api/drafts/me` | Load / save the signed-in create-flow draft. | +| POST | `/api/uploads` | Multipart upload (requires `UPLOAD_ROOT`). | +| GET | `/api/uploads/[id]` | Stream a previously uploaded file (public). | + +### Rules + +| Method | Path | Purpose | +| --- | --- | --- | +| GET, POST | `/api/rules` | List or publish rules. | +| GET | `/api/rules/me` | Owner's published rules. | +| GET, PATCH, DELETE | `/api/rules/[id]` | Public read; owner update / delete. | +| POST | `/api/rules/[id]/duplicate` | Owner clone. | +| GET, POST | `/api/rules/[id]/stakeholders` | List / invite stakeholders. | +| DELETE | `/api/rules/[id]/stakeholders/[stakeholderId]` | Remove stakeholder. | +| POST | `/api/rules/[id]/stakeholders/[stakeholderId]/resend` | Resend invite email. | +| GET | `/api/invites/rule-stakeholder/verify` | Verify stakeholder invite token. | + +### Templates & create-flow catalog + +| Method | Path | Purpose | +| --- | --- | --- | +| GET | `/api/templates` | List curated templates. Repeatable `facet.=` query params re-rank results. | +| GET | `/api/templates/[slug]` | Single template with normalized `{ section, slug }` composition. | +| GET | `/api/create-flow/methods` | Built-in governance methods / core values for the wizard. Required `section` query param. | + +Facet semantics and the recommendation matrix: +[`docs/guides/template-recommendation-matrix.md`](docs/guides/template-recommendation-matrix.md) +§9. + +### Misc + +| Method | Path | Purpose | +| --- | --- | --- | +| POST | `/api/organizer-inquiry` | "Ask an organizer" form submission. | +| POST | `/api/use-cases/[slug]/duplicate` | Duplicate a use-case demo rule. | +| GET, POST | `/api/web-vitals` | Read / ingest web vitals. Storage mode set by `WEB_VITALS_STORAGE` (`local` in dev, `external` in prod). | + +## Testing + +The full testing recipe and philosophy live in +[`docs/testing-guide.md`](docs/testing-guide.md). Component conventions +and shared helpers are in `.cursor/rules/testing.mdc`. + +A typical pre-merge subset: + +```bash +npx tsc --noEmit +npm run knip +npm test +npx next build +``` + +Add `npm run e2e` for routing, auth, or critical-flow changes, and +`npm run migrate:smoke` for anything under `prisma/`. + +## Pull-request workflow 1. Branch from `main`: `git checkout -b feature/`. -2. Make the change and add/update tests. -3. Before merging, run [docs/testing-guide.md](docs/testing-guide.md#running-tests) *Running tests*. -4. Commit using a clear message (`feat:`, `fix:`, `chore:`, …). -5. Open a pull request. +2. Make the change and add or update tests. +3. Run the relevant subset of the testing recipe above. +4. Commit using a conventional-commit prefix: `feat:`, `fix:`, + `chore:`, `docs:`, `refactor:`, `test:`. +5. Open a pull request; link the Linear ticket if there is one (e.g. + `CR-123`). diff --git a/README.md b/README.md index 6ada988..318ecb6 100644 --- a/README.md +++ b/README.md @@ -1,66 +1,82 @@ # Community Rule A Next.js application for community decision-making and governance -documentation. +documentation — author, browse, and share governance "rules" built from +curated templates and a guided wizard. + +Live at [communityrule.info](https://communityrule.info). Packaged as a +Cloudron app for MEDLab; see +[docs/guides/ops-backend-deploy.md](docs/guides/ops-backend-deploy.md) +for the deployment handoff. ## Requirements - Node.js **20+** (LTS) - npm **10+** +- Docker (for local Postgres and Mailhog) -## Getting started +## Quick start ```bash +cp .env.example .env # then set SESSION_SECRET (≥16 chars) +docker compose up -d postgres # add `mailhog` for a local inbox npm ci +npx prisma migrate dev npm run dev ``` -Open [http://localhost:3000](http://localhost:3000). +Open [http://localhost:3000](http://localhost:3000). Without +`CLOUDRON_MAIL_SMTP_*` set, magic-link sign-in URLs are printed to the +dev-server log instead of emailed. -Backend setup (Postgres, Prisma, magic-link auth) is documented in +Full local backend, API reference, and PR workflow: [CONTRIBUTING.md](CONTRIBUTING.md). -## Common scripts +## Scripts | Command | What it does | | --- | --- | | `npm run dev` | Next.js dev server (Turbopack). | | `npm run build` / `npm start` | Production build / serve. | | `npm test` | Vitest unit + component tests with coverage. | -| `npm run test:component` | Faster inner loop — components only. | +| `npm run test:component` | Components only — faster inner loop. | | `npm run e2e` | Playwright E2E + visual regression. | +| `npm run migrate:smoke` | Throwaway Postgres + `prisma migrate deploy` (Docker required). | | `npm run storybook` | Storybook on port 6006. | +| `npm run knip` | Detect unused files / exports. | | `npm run lhci` | Lighthouse CI performance pass. | +See [`package.json`](package.json) for the full list (visual regression, +bundle analysis, seeding, etc.). + ## Project layout ```text -app/ Next.js app router: route groups (marketing), (app), (admin), (dev); - shared components under app/components/; optional _components/ - colocated with a route (e.g. (admin)/monitor/_components/) -lib/ Shared library code (i18n, validation, utilities) -messages/en/ Localized UI copy (see docs/guides/i18n-translation-workflow.md) -prisma/ Database schema, migrations, seed -public/ Static assets -stories/ Storybook stories -tests/ Vitest + Playwright suites -docs/ User-facing documentation (start with docs/README.md) -.cursor/rules/ Implementation conventions enforced by Cursor +app/ Next.js app router — route groups (marketing), (app), + (admin), (dev); shared components under app/components/; + admin-only widgets under app/(admin)//_components/ +lib/ Shared library code (server, validation, create-flow logic) +prisma/ Schema, migrations, seed +messages/en/ Localized UI copy (single-locale today; English) +public/ Static assets +stories/ Storybook stories +tests/ Vitest + Playwright suites (mirror source paths) +docs/ Human-facing documentation — start at docs/README.md +.cursor/rules/ Per-file conventions (auto-loaded by Cursor) +scripts/ Build, release, and smoke-test scripts ``` ## Tech stack -Next.js 16 · React 19 · TypeScript · Tailwind CSS 4 · Prisma · Vitest · -Playwright · Storybook 10 · Lighthouse CI. +Next.js 16 · React 19 · TypeScript · Tailwind CSS 4 · Prisma 6 · +PostgreSQL · Vitest · Playwright · Storybook 10 · Lighthouse CI. ## Documentation - [docs/README.md](docs/README.md) — index of guides and rules. - [docs/create-flow.md](docs/create-flow.md) — create-rule wizard canon. - [docs/testing-guide.md](docs/testing-guide.md) — testing philosophy. -- [CONTRIBUTING.md](CONTRIBUTING.md) — local backend, API routes, PR - workflow. - -## License - -[MIT](LICENSE). +- [docs/guides/ops-backend-deploy.md](docs/guides/ops-backend-deploy.md) + — Cloudron deploy + cutover plan. +- [CONTRIBUTING.md](CONTRIBUTING.md) — local backend, API routes, PR workflow. +- [AGENTS.md](AGENTS.md) — orientation for AI coding agents. -- 2.43.0 From 22ccc02b70684bc86063c583b9d313c270bda380 Mon Sep 17 00:00:00 2001 From: adilallo <39313955+adilallo@users.noreply.github.com> Date: Sat, 23 May 2026 16:52:18 -0600 Subject: [PATCH 3/3] Add license and other docs --- LICENSE | 674 ++++++++++++++++++++++++++ README.md | 11 + docs/guides/backend-linear-tickets.md | 6 +- docs/guides/ops-backend-deploy.md | 13 +- package.json | 1 + 5 files changed, 696 insertions(+), 9 deletions(-) create mode 100644 LICENSE diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..c1d2d6f --- /dev/null +++ b/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + CommunityRule + Copyright (C) 2020 Media Enterprise Design Lab + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + CommunityRule Copyright (C) 2020 Media Enterprise Design Lab + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/README.md b/README.md index 318ecb6..99dcb75 100644 --- a/README.md +++ b/README.md @@ -80,3 +80,14 @@ PostgreSQL · Vitest · Playwright · Storybook 10 · Lighthouse CI. — Cloudron deploy + cutover plan. - [CONTRIBUTING.md](CONTRIBUTING.md) — local backend, API routes, PR workflow. - [AGENTS.md](AGENTS.md) — orientation for AI coding agents. + +## License + +Application source code is licensed under the +[GNU General Public License v3.0](LICENSE), the same license as the +legacy [GitLab project](https://gitlab.com/medlabboulder/communityrule). +Copyright (C) 2020 Media Enterprise Design Lab. + +User-facing content (guides, template copy, marketing text) is licensed +under [CC BY-SA 4.0](https://creativecommons.org/licenses/by-sa/4.0/), +as stated on [communityrule.info/about](https://communityrule.info/about/). diff --git a/docs/guides/backend-linear-tickets.md b/docs/guides/backend-linear-tickets.md index 791fdf0..740b3b2 100644 --- a/docs/guides/backend-linear-tickets.md +++ b/docs/guides/backend-linear-tickets.md @@ -12,7 +12,7 @@ A backend review was merged into **[docs/backend-roadmap.md](backend-roadmap.md) - **Done in Linear and shipped:** **CR-72–CR-76**, **CR-77** (publish from create flow), **CR-78** (template seed), **CR-79**, **CR-88**, **CR-89**. The **CR-72 → CR-83** numbering is the original **sequential plan**, not current blocking order; the **core product vertical** through publish + templates is effectively complete in-repo. - **Backlog (still open):** **CR-80** (web vitals — file-based route remains), **CR-86** (profile + account + draft resume — UI mostly placeholder), **CR-103** (change account email — Ticket 20), **CR-90** / **CR-91**, **CR-93** (template grid facets on marketing). **CR-81 Done** — public rule detail shipped: [`app/(marketing)/rules/[id]/page.tsx`](../../app/(marketing)/rules/[id]/page.tsx), [`app/api/rules/[id]/route.ts`](../../app/api/rules/[id]/route.ts). **CR-82** (migrate smoke): **local** `npm run migrate:smoke` + [CONTRIBUTING.md](../../CONTRIBUTING.md) / [docs/testing-guide.md](../testing-guide.md) — in-repo Gitea workflow YAML **removed**; optional future remote job if hosted runners return. **CR-84 Done** — canonical error contract `{ error: { code, message }, details? }` and `x-request-id` propagation shipped via `lib/server/{responses,requestId,apiRoute}.ts`; auth + drafts + rules routes migrated, remaining `app/api/*` are a follow-up pass. **CR-85 Done** — multi-device session policy + lazy expired-row cleanup (per-user prune on every sign-in plus ~5% global sweep, no cron); ADR comment block in [`lib/server/session.ts`](../../lib/server/session.ts). -- **CR-83 Done (admin handoff + cutover plan):** [`docs/guides/ops-backend-deploy.md`](ops-backend-deploy.md) shipped. Cloudron admin access on `cloud.medlab.host` granted; doc now covers (a) what's in place, (b) the side-by-side → apex cutover plan, and (c) the two open product questions + registry decision still outstanding. Steady-state operator runbook is split out into a follow-up — see [Ticket 12 / CR-83 follow-ups](#follow-up-tickets-filed-under-cr-83) below. Key new finding: legacy `communityrule.info` is a single Cloudron **LAMP** app (`lamp.cloudronapp.php74@5.1.2`) hosting marketing site + Express/MySQL backend + a broken Flask chatbot all in one container; all three retire together via CR-99 + CR-101. +- **CR-83 Done (admin handoff + cutover plan):** [`docs/guides/ops-backend-deploy.md`](ops-backend-deploy.md) shipped. Cloudron admin access on `my.medlab.host` granted; doc now covers (a) what's in place, (b) the side-by-side → apex cutover plan, and (c) the two open product questions + registry decision still outstanding. Steady-state operator runbook is split out into a follow-up — see [Ticket 12 / CR-83 follow-ups](#follow-up-tickets-filed-under-cr-83) below. Key new finding: legacy `communityrule.info` is a single Cloudron **LAMP** app (`lamp.cloudronapp.php74@5.1.2`) hosting marketing site + Express/MySQL backend + a broken Flask chatbot all in one container; all three retire together via CR-99 + CR-101. - **CR-86** is **no longer blocked** by publish — **CR-77** is **Done**; profile work is gated by **implementation**, not waiting on publish wiring. - **Not in this ticket list** but called out in **[docs/backend-roadmap.md](backend-roadmap.md):** shared **rate-limit store** (e.g. Redis) before multi-instance; **`GET /api/create-flow/methods`** exists for facet scoring (Ticket 16 / CR-88) but is not duplicated as a separate doc ticket. @@ -632,11 +632,11 @@ _Section B — Final Review screen `+` button per category:_ **Depends on:** Tickets 1–8 complete enough to deploy a vertical slice. -**Server / admin:** Cloudron admin access on `cloud.medlab.host` granted. Scope of this ticket is the **handoff doc + cutover plan** — exactly what's in place, what the side-by-side cutover looks like, and what open product/infra questions remain. The steady-state operator runbook is split out into [CR-100](https://linear.app/community-rule/issue/CR-100/backend-steady-state-operator-runbook) (we write it after we've done the work). +**Server / admin:** Cloudron admin access on `my.medlab.host` granted. Scope of this ticket is the **handoff doc + cutover plan** — exactly what's in place, what the side-by-side cutover looks like, and what open product/infra questions remain. The steady-state operator runbook is split out into [CR-100](https://linear.app/community-rule/issue/CR-100/backend-steady-state-operator-runbook) (we write it after we've done the work). **Goal:** Short doc that captures (a) granted access + auto-injected vs. manually-set env vars + platform settings, (b) the side-by-side → apex cutover plan with the legacy `communityrule.info` service, and (c) the remaining open questions (apex vs. permanent-subdomain final URL, legacy `rules` data communication, container registry choice). -**Platform context:** Target is **Cloudron at MEDLab** (`cloud.medlab.host`). The legacy `communityrule.info` is a single Cloudron **LAMP** app (`lamp.cloudronapp.php74@5.1.2`, 512 MiB at apex) hosting **three things stuffed into one container** under `/app/data/public/`: the static marketing site, the Express/MySQL backend at [`CommunityRule/CommunityRuleBackend`](https://git.medlab.host/CommunityRule/CommunityRuleBackend) (kept alive by a 30-min `run.sh` watchdog on port 3000; MySQL is the LAMP package's bundled MySQL, not a Cloudron addon), and the Flask chatbot at [`CommunityRule/CommunityRuleChatBot`](https://git.medlab.host/CommunityRule/CommunityRuleChatBot) (currently crash-looping with `ModuleNotFoundError`, last touched May 2024). New app is a properly packaged Cloudron app (Docker image + `CloudronManifest.json`, **postgresql + sendmail + localstorage** addons) and replaces all three — **no data migration**. Cloudron's container supervisor replaces the watchdog. +**Platform context:** Target is **Cloudron at MEDLab** (`my.medlab.host`). The legacy `communityrule.info` is a single Cloudron **LAMP** app (`lamp.cloudronapp.php74@5.1.2`, 512 MiB at apex) hosting **three things stuffed into one container** under `/app/data/public/`: the static marketing site, the Express/MySQL backend at [`CommunityRule/CommunityRuleBackend`](https://git.medlab.host/CommunityRule/CommunityRuleBackend) (kept alive by a 30-min `run.sh` watchdog on port 3000; MySQL is the LAMP package's bundled MySQL, not a Cloudron addon), and the Flask chatbot at [`CommunityRule/CommunityRuleChatBot`](https://git.medlab.host/CommunityRule/CommunityRuleChatBot) (currently crash-looping with `ModuleNotFoundError`, last touched May 2024). New app is a properly packaged Cloudron app (Docker image + `CloudronManifest.json`, **postgresql + sendmail + localstorage** addons) and replaces all three — **no data migration**. Cloudron's container supervisor replaces the watchdog. **Implementation (shipped):** diff --git a/docs/guides/ops-backend-deploy.md b/docs/guides/ops-backend-deploy.md index 0b571ea..81010a4 100644 --- a/docs/guides/ops-backend-deploy.md +++ b/docs/guides/ops-backend-deploy.md @@ -42,8 +42,9 @@ registry + first image push) are done; the remaining gate is ## 2. Access — granted -Cloudron admin login on `cloud.medlab.host` granted. From the -dashboard the deployer can self-serve: +Cloudron admin login on `my.medlab.host` granted (note: this is the +**Cloudron dashboard**, not `cloud.medlab.host`, which is MEDLab's +Nextcloud file portal). From the dashboard the deployer can self-serve: - [x] **Cloudron admin login** (full admin on the MEDLab instance). - [x] **DNS for `communityrule.info`** — domain is managed inside @@ -311,7 +312,7 @@ standalone server. ### Install / update on Cloudron From the repo dir on the operator's machine, with `cloudron` CLI -logged in to `cloud.medlab.host`: +logged in to `my.medlab.host`: ```bash # First install (staging): @@ -349,8 +350,8 @@ production env vars, and verify the vertical slice before apex cutover `git.medlab.host/communityrule/community-rule:0.1.0` (or current tag in manifest); repo is **public**; anonymous amd64 pull verified (§9). - [ ] **Cloudron CLI token** — generate at *Profile → API Tokens* on - `cloud.medlab.host`; save in 1Password (§2). -- [x] **Cloudron admin login** on `cloud.medlab.host` (§2). + `my.medlab.host`; save in 1Password (§2). +- [x] **Cloudron admin login** on `my.medlab.host` (§2). - [x] **DNS** — `communityrule.info` managed in Cloudron; staging subdomain will be provisioned at install time. @@ -362,7 +363,7 @@ production env vars, and verify the vertical slice before apex cutover `git.medlab.host/communityrule/community-rule:0.1.0`). 2. **Log in to Cloudron CLI:** ```bash - cloudron login cloud.medlab.host + cloudron login my.medlab.host ``` 3. **Install** from the repo root (manifest is read automatically): ```bash diff --git a/package.json b/package.json index 03d2feb..4a843b2 100644 --- a/package.json +++ b/package.json @@ -2,6 +2,7 @@ "name": "community-rule", "version": "0.1.0", "private": true, + "license": "GPL-3.0-or-later", "engines": { "node": ">=20.0.0" }, -- 2.43.0