Staging install prep: docs, license, and smoke script #58

Merged
an.di merged 3 commits from adilallo/Backend/StagingInstall into main 2026-05-23 22:55:42 +00:00
Owner

Overview

Prepares the repo for the Cloudron staging install (CR-98). No runtime or container changes — documentation, licensing, operator tooling, and corrected deploy references so the next cloudron install run uses the right hostname.

Changes

  • scripts/staging-smoke.sh — curl-based smoke checks for post-install validation (health, templates, create-flow methods, optional magic-link request). Referenced from docs/guides/ops-backend-deploy.md §10.
  • README.md — clearer quick start (Docker + Prisma), project layout, deploy pointer, and license section.
  • CONTRIBUTING.md — rewritten local setup, grouped API route tables, testing recipe, PR workflow; Cloudron host corrected to my.medlab.host.
  • LICENSE — GPL-3.0 from the legacy GitLab project (medlabboulder/communityrule); CC BY-SA 4.0 noted for user-facing content.
  • package.json"license": "GPL-3.0-or-later".
  • docs/guides/ops-backend-deploy.md — Cloudron dashboard hostname fixed (my.medlab.host; cloud.medlab.host is Nextcloud).
  • docs/guides/backend-linear-tickets.md — same hostname fix in CR-83 / Ticket 12 narrative.

How to Test

  1. Read through README.md and CONTRIBUTING.md — confirm quick-start steps match a fresh clone (cp .env.example .env, docker compose up -d postgres, npm ci, npx prisma migrate dev, npm run dev).
  2. Confirm LICENSE matches the legacy GitLab LICENSE.
  3. After staging is installed, run:
    ./scripts/staging-smoke.sh staging.communityrule.info
    
    Optional: EMAIL=you@example.com ./scripts/staging-smoke.sh staging.communityrule.info
  4. Verify ops doc references my.medlab.host for cloudron login and API tokens.
## Overview Prepares the repo for the Cloudron staging install (CR-98). No runtime or container changes — documentation, licensing, operator tooling, and corrected deploy references so the next `cloudron install` run uses the right hostname. ## Changes - **`scripts/staging-smoke.sh`** — curl-based smoke checks for post-install validation (health, templates, create-flow methods, optional magic-link request). Referenced from `docs/guides/ops-backend-deploy.md` §10. - **`README.md`** — clearer quick start (Docker + Prisma), project layout, deploy pointer, and license section. - **`CONTRIBUTING.md`** — rewritten local setup, grouped API route tables, testing recipe, PR workflow; Cloudron host corrected to `my.medlab.host`. - **`LICENSE`** — GPL-3.0 from the legacy GitLab project (`medlabboulder/communityrule`); CC BY-SA 4.0 noted for user-facing content. - **`package.json`** — `"license": "GPL-3.0-or-later"`. - **`docs/guides/ops-backend-deploy.md`** — Cloudron dashboard hostname fixed (`my.medlab.host`; `cloud.medlab.host` is Nextcloud). - **`docs/guides/backend-linear-tickets.md`** — same hostname fix in CR-83 / Ticket 12 narrative. ## How to Test 1. Read through `README.md` and `CONTRIBUTING.md` — confirm quick-start steps match a fresh clone (`cp .env.example .env`, `docker compose up -d postgres`, `npm ci`, `npx prisma migrate dev`, `npm run dev`). 2. Confirm `LICENSE` matches the [legacy GitLab LICENSE](https://gitlab.com/medlabboulder/communityrule/-/raw/master/LICENSE). 3. After staging is installed, run: ```bash ./scripts/staging-smoke.sh staging.communityrule.info ``` Optional: `EMAIL=you@example.com ./scripts/staging-smoke.sh staging.communityrule.info` 4. Verify ops doc references `my.medlab.host` for `cloudron login` and API tokens.
an.di added 3 commits 2026-05-23 22:55:29 +00:00
an.di self-assigned this 2026-05-23 22:55:34 +00:00
an.di merged commit bb4ef2ac4b into main 2026-05-23 22:55:42 +00:00
an.di deleted branch adilallo/Backend/StagingInstall 2026-05-23 22:55:43 +00:00
Sign in to join this conversation.
No Reviewers
No Label
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: CommunityRule/community-rule#58