Skip to main content

Overview for developers

Study Manager is a TypeScript monorepo (pnpm workspaces). It should work for as many students as possible – help is welcome, from typos to connecting a new university.

Where do I start?​

  1. Running locally: get the project running on your machine.
  2. Architecture: how the parts work together.
  3. Pick an issue with the label good first issue or an idea under Connecting universities.
  4. Contributing: branches, commits, pull requests.
  5. Tests and releases.

The parts​

FolderContent
apps/webWeb app (React 19, Vite, React Router, FullCalendar)
apps/serverAPI, MCP server and background jobs (Node.js 24, Fastify, Drizzle, pg-boss)
packages/uiBuilding blocks and design ("Snug Simple") – see design system
packages/sharedShared types and rules (roles, drafts, module schema)
apps/e2eEnd-to-end tests with Playwright
apps/docsThis documentation (Docusaurus)
infraDockerfiles, Caddy, test data, scripts
apps/docs/docs/developers/decisionsArchitecture decisions (ADRs)
apps/docs/docs/developers/glossary.mdxGlossary of the terms (course, deadline, task …)
.claude/Instructions for Claude and developers (commit rules, check commands, rules per area), loaded automatically by Claude Code

Principles​

  • No AI on the server. Claude works through MCP with the user's permissions; what used to happen automatically is listed in a work inbox. See ADR 0002.
  • Only building blocks from @study/ui in the interface (a CI check watches this).
  • Self-host, keep it simple. One Docker Compose project, one reverse proxy in front.
  • Invented test data. No real people, universities or credentials in tests, examples and docs.