Skip to content

development.md

Latest commit

 

History

History
66 lines (53 loc) · 2.5 KB

development.md

File metadata and controls

66 lines (53 loc) · 2.5 KB
Raw

Development

How MSK Forms is built and how to work on it. Requirements, branches, commit conventions and the pull request checklist are in CONTRIBUTING.md. The full concept document is maintained internally.

Tech stack

Area Technology
Frontend/SSR Next.js 16 (App Router), TypeScript
Styling Tailwind CSS 4
Design Archivo and Source Sans 3 via @fontsource-variable, Phosphor icons, design system in DESIGN.md
Database PostgreSQL + Prisma
Cache Redis
Bot Node.js + discord.js v14
Storage S3-compatible (MinIO)
i18n 7 languages (EN/DE/HU/FR/ES/PT/PL)
Monorepo pnpm Workspaces + Turborepo
Hosting Debian + Apache2 + PM2

The fonts are self-hosted: they come from the @fontsource-variable packages and are bundled with the app, so the build fetches nothing from Google and the browser loads no font from another host.

Project structure

msk-forms/
├── apps/
│   ├── web/         Next.js (dashboard, builder, public forms, status)
│   ├── bot/         discord.js bot (multi-tenant)
│   └── realtime/    WebSocket service (Postgres LISTEN/NOTIFY fan-out)
├── packages/
│   ├── db/          Prisma schema & client
│   ├── shared/      Types, zod schemas, form spec
│   ├── ui/          MSK design system
│   └── i18n/        Unused stub; the translations live in apps/web/src/i18n
└── .github/         CI, deploy, Dependabot, CodeQL

Local development

You need Node.js 24 or newer, pnpm 12 (corepack enable) and Docker.

pnpm install
cp .env.example .env        # fill in values
docker compose up -d        # Postgres, Redis, MinIO
pnpm prisma migrate dev
pnpm dev                    # web on http://localhost:3000, plus bot and realtime

docker compose up -d also creates the msk-forms bucket in MinIO, so uploads work locally with the S3 values from .env.example. Postgres runs the same major version as production (18). Coming from an older checkout with Postgres 16, the compose file starts on a new, empty volume: run pnpm prisma migrate dev once (and pnpm db:seed for sample data).

Branches and CI/CD

  • main → production (auto-deploy via SSH → PM2); direct pushes are blocked.
  • Feature branches → PR against main → squash-merge once CI is green.

Every PR runs CI (lint, typecheck, build, test, Prisma validate) and CodeQL. Merging to main deploys automatically to forms.msk-scripts.de.