Skip to content

COMMANDS.md

Latest commit

 

History

History
199 lines (148 loc) · 7.69 KB

COMMANDS.md

File metadata and controls

199 lines (148 loc) · 7.69 KB
Raw
created_date 2026-01-07
last_modified_date 2026-07-04
last_modified_summary IT-Hilfe journey E2E (edit + withdraw); local run notes

RevampIT Commands Reference (SSOT)

Single Source of Truth for all npm scripts and commands.

Quick Start Commands

npm run d              # Start everything (databases + dev server)
npm run dev            # Frontend only (port 3000)
npm run services:up    # Start Docker services (db, redis, meilisearch)
npm run services:down  # Stop Docker services
npm run setup-admins   # Create admin users

Development Commands

npm run dev            # Start Next.js dev server (port 3000)
npm run dev:cms        # Start CMS (currently disabled)

Docker Services

npm run services:up    # Start all services (db, redis, meilisearch)
npm run services:down  # Stop all services
npm run db:up          # Start main database only
npm run db:down        # Stop main database
npm run setup          # Start database and wait 5 seconds
npm run reset          # Stop all, remove volumes, and reset

Build & Production

npm run build          # Production build (Next.js + sitemap)
npm run start          # Start production server
npm run typecheck      # TypeScript validation (run before commits!)
npm run lint           # ESLint check
npm run i18n:businessplan  # Business plan i18n shape/invariant parity (8 locales)

Monitor-Upcycling content scripts

node scripts/sync-businessplan-locales.mjs   # After editing DE businessPlan block
node scripts/prune-businessplan-archive.mjs  # Remove archived citation keys from all locales

See docs/projects/upcycling.md for mini-site SSOT map.

Testing

npm run test           # Jest unit tests
npm run test:watch     # Jest watch mode
npm run test:coverage  # Jest with coverage
npm run test:e2e       # Playwright E2E tests
npm run test:e2e:auth  # Auth login smoke (needs AUTH_TEST_EMAIL/PASSWORD)
npm run test:e2e:inventory # Dual-persona feature inventory (user + admin)
npm run test:e2e:inventory:prod # Same, with prod health wait (CI / post-deploy)
npm run test:e2e:user-admin # Legacy quick smoke (subset)
npm run test:e2e:it-hilfe    # IT-Hilfe hub/journey specs
npm run test:e2e:it-hilfe:journey # Dual-persona lifecycle + edit/withdraw (see E2E section)
npm run test:e2e:marketplace:journey # User sells, admin buys (Payrexx when configured)
npm run test:e2e:workshops:proposal:journey # User proposes, admin approve/reject
npm run test:e2e:timecards:journey          # Staff submit + admin approve (TIME round-trip)
npm run test:e2e:intake:journey             # Admin intake create → checklist → publish
npm run test:e2e:tasks:journey              # Admin task create → complete
npm run test:e2e:protocols:journey          # Admin protocol create → JSON import → finalize
npm run test:e2e:decisions:journey          # Admin decision create → vote → close
npm run test:e2e:cms:journey                # Admin blog draft → publish → public view
npm run test:e2e:it-hilfe:preferred:journey # Request with preferred techniker
npm run test:e2e:service:journey # User books repair, admin assigns techniker (dual-persona)
npm run test:e2e:ui    # Playwright with UI
npm run test:all       # Run all tests

Deployment

Production app: https://revampit.orangecat.ch (Hetzner self-host). Public legacy domain revamp-it.ch is still the old Joomla/Apache site and is not the production app.

Automatic (push-to-deploy)

Trigger What happens
git push origin main (local) Pre-push hook builds + deploys in background → /tmp/push-deploy-revampit.log
git push origin main (GitHub) Actions workflow .github/workflows/deploy-selfhost.yml runs lint + typecheck, then deploys if secrets are set

Requires .env.selfhost.local locally (gitignored). Copy from a teammate or recreate from the prod /opt/revampit/app/.env.

One-time GitHub secrets (Settings → Secrets → Actions) for CI deploy when you push from anywhere:

Secret Value
HETZNER_SSH_PRIVATE_KEY Private key for ubuntu@167.233.22.31
SELFHOST_ENV Full contents of .env.selfhost.local
AUTH_TEST_USER_PASSWORD Non-admin E2E account (butaeff@gmail.com) — post-deploy + CI inventory
AUTH_TEST_ADMIN_PASSWORD Staff E2E account (georgy.butaev@revamp-it.ch) — post-deploy + CI inventory
AUTH_TEST_USER_EMAIL Optional override for user persona (defaults to butaeff)
AUTH_TEST_ADMIN_EMAIL Optional override for admin persona (defaults to georgy)
AUTH_TEST_EMAIL / AUTH_TEST_PASSWORD Legacy single-account auth smoke (test:e2e:auth)
PLAYWRIGHT_CHANNEL chrome or msedge when bundled Chromium cannot install (e.g. Ubuntu 26)

Local marketplace journey (no prod secrets):

npm run e2e:seed
PLAYWRIGHT_CHANNEL=chrome \
AUTH_TEST_USER_EMAIL=e2e-user@revampit.test AUTH_TEST_USER_PASSWORD='E2EUser123!' \
AUTH_TEST_ADMIN_EMAIL=e2e-admin@revampit.test AUTH_TEST_ADMIN_PASSWORD='E2EAdmin123!' \
npm run test:e2e:marketplace:journey

Local IT-Hilfe dual-persona journey (owner edit + withdraw offer + full lifecycle):

npm run e2e:seed
PLAYWRIGHT_CHANNEL=chrome PLAYWRIGHT_BASE_URL=http://localhost:3001 \
AUTH_TEST_USER_EMAIL=e2e-user@revampit.test AUTH_TEST_USER_PASSWORD='E2EUser123!' \
AUTH_TEST_ADMIN_EMAIL=e2e-admin@revampit.test AUTH_TEST_ADMIN_PASSWORD='E2EAdmin123!' \
npm run test:e2e:it-hilfe:journey

Use npx next dev --port 3001 --webpack locally if Turbopack returns 404 on /api/auth/*. Restart the dev server if create-request rate limit (Zu viele Anfragen) trips during repeated runs.

Apply migration 114_listing_questions.sql before first local run (npm run db:migrate or direct psql). Prod: applied on Hetzner 2026-07-04 (see docs/FEATURE_INVENTORY.md → Marketplace UX rollout tracker).

After each successful deploy, Dual-persona inventory smoke runs automatically when the two password secrets are set (routes + IT-Hilfe + marketplace + workshops + service journeys). Manual re-run: npm run test:e2e:inventory:prod.

Payrexx go-live checklist: docs/operations/PAYREXX_SETUP.md · config SSOT: src/config/payrexx.ts.

Manual

npm run deploy          # same as deploy:selfhost
npm run deploy:selfhost # build standalone → release backup → activate → /api/health gate → rollback on failure
npm run ship            # quality gate (typecheck, lint, build, tests)
npm run db:migrate      # apply unrecorded scripts/db/migrations/*.sql (DATABASE_URL / PG* env)

Operational checks:

curl https://revampit.orangecat.ch/api/health  # dependency health
curl https://revampit.orangecat.ch/api/version # deployed version / git SHA

Production dependencies on the Hetzner box:

Service Runtime Binding Notes
revampit-app systemd 127.0.0.1:4004 behind Caddy /opt/revampit/app, restarted by scripts/selfhost-deploy-evig.sh
revampit_meilisearch Docker 127.0.0.1:7700 Required for healthy /api/health; master key is stored only in /opt/revampit/app/.env

The deploy script copies the server-local .env and launch.sh into each release before activation. Do not put those runtime secrets in git.

Database

npm run db:migrate-users  # Migrate existing users

Production Docker

npm run prod:build     # Build production Docker image
npm run prod:up        # Start production containers
npm run prod:down      # Stop production containers

Last Updated: 2026-06-19
Last Modified Summary: Post-deploy dual-persona inventory in GitHub Actions; E2E secret docs.
Source: package.json