diff --git a/README.md b/README.md index 17c7e10..66a6e55 100644 --- a/README.md +++ b/README.md @@ -74,15 +74,20 @@ crdc-demo/ ## Deployment -### Option A: Git Pages (self-hosted equivalent — recommended) -The app is a static site. Upload the `dist/` directory to your self-hosted Git Pages server after building: +### Option A: Git Pages via Gitea Actions (recommended) +The app is a static site deployed automatically via Gitea Actions. On every push to `main`, the workflow in +`.gitea/workflows/pages.yml` builds the Vite app and copies `dist/` to a `pages` branch served by the +git-pages webhook receiver. -```bash -npm run build # produces dist/ -# Upload dist/ contents to your git-pages host -``` +**URL**: `https://pages.civilytics.org/crdc-demo/` -For CI/CD, see `.github/workflows/deploy.yml` which builds and uploads artifacts automatically on push to `main`. +The workflow follows the same pattern as `Civilytics/sln-school-comparison`: +1. Triggers on push to `main` (only when source files change) +2. Builds with Node 22 + Vite (`npm ci && npm run build`) +3. Copies `dist/` contents to an orphan `pages` branch +4. Forces push — the git-pages webhook picks it up automatically + +> **Note**: Ensure `${{ secrets.GITHUB_TOKEN }}` is configured in repo settings on gitea.civilytics.org. ### Option B: Docker (self-hosted fleet) Build and run the nginx container on your infrastructure (`efron`, `maxwell`, etc.):