Skip to content

CLAUDE.md

Latest commit

 

History

History
70 lines (54 loc) · 3.24 KB

CLAUDE.md

File metadata and controls

70 lines (54 loc) · 3.24 KB

CLAUDE.md

This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.

Project Overview

Internal tools app for Blindern Studenterhjem (foreningenbs.no/intern/). Monorepo with two services: a TanStack Start fullstack app and a Node.js calendar API.

Architecture

  • App (app/): TanStack Start (SPA mode), React, TypeScript, Vite, Hono server. Serves the SPA at /intern/ and API routes at /intern/api/. Uses Drizzle ORM with PostgreSQL. Auth via SAML2. Server-only code in src/server/. Routes use TanStack Router file-based routing in src/routes/. Models use 24-char hex string IDs (MongoDB ObjectId format). React Query for data fetching, React Hook Form, Bootstrap Sass 3.
  • Calendar API (calendar-api/): Elysia (Node.js), TypeScript. Aggregates Confluence + historical calendar data. Exposes JSON and iCalendar endpoints.

App structure (app/src/)

  • features/ — domain modules organized by feature. Each feature directory contains:
    • *Page.tsx — page components (UI logic)
    • hooks.ts — React Query hooks wrapping server functions
    • server-fns.ts — TanStack Start server functions (RPC-style, called from client)
    • Additional components and utilities as needed
  • routes/ — file-based routes (TanStack Router). Thin wrappers that import page components from features/ and wire up routing. Route params are extracted in the route file and passed as props. API routes under routes/api/.
  • server/ — server-only code: database, auth, email, SAML2, session, env config.
  • components/ — shared React components used across features.
  • hooks/ — shared React hooks (title management, flash messages).
  • styles/ — SCSS stylesheets (Bootstrap 3 based).
  • utils/ — shared utilities.

Auth integrates with an external Users API (users-api.zt.foreningenbs.no) via HMAC-authenticated requests for user/group management.

Commands

Commands are run from each service's directory.

App (app/)

pnpm install
pnpm dev                            # Dev server
docker compose up database          # PostgreSQL on :5432
pnpm build
pnpm lint                           # ESLint
pnpm lint:fix
pnpm typecheck

Calendar API (calendar-api/)

pnpm install
pnpm serve                          # Server on :8000
pnpm lint
pnpm typecheck
pnpm test                           # Vitest
pnpm test src/some-file.test.ts     # Single test

Conventions

  • 2-space indentation, LF line endings, UTF-8 (see .editorconfig)
  • Package manager: pnpm
  • Docker images pushed to ghcr.io/blindern/intern-{app,calendar-api}
  • CI runs per-service on push to respective directory (.github/workflows/)
  • OpenTelemetry instrumentation via --import ./instrumentation.ts

SQL formatting (raw queries)

Keywords UPPERCASE: SELECT, FROM, WHERE, JOIN, GROUP BY, ORDER BY, LIMIT, WITH, AS, DISTINCT, AND, OR, ON, CROSS JOIN Functions lowercase: count(), sum(), min(), max(), coalesce(), extract(), lower(), to_char(), generate_series() extract() field names UPPERCASE: extract(MONTH FROM ...), extract(DOW FROM ...) Alias with lowercase as: count(j.id) as total JOINs indented 2 spaces from FROM SELECT columns aligned with padding