Skip to content

README.md

Latest commit

 

History

History
28 lines (18 loc) · 1.71 KB

README.md

File metadata and controls

28 lines (18 loc) · 1.71 KB

Server

The Express backend for 2026 Boilerplate. Served alongside the Vite-built client via vite-express.

Cursor rule reference: .cursor/rules/server-patterns.mdc

Entry

main.ts — Creates the Express app, attaches middleware and routes, then starts the server with ViteExpress.listen. In development, Vite serves the client with HMR; in production, built assets are served from dist/.

Structure

Follows an MVC-style layout:

  • routes/ — Route definitions. Auth routes (REST session endpoints + legacy login/logout compatibility), API routes (e.g. /api/key), page routes (redirect middleware + pass-through to Vite or serve sitemap).
  • controllers/ — Request handlers. Call services and send responses.
  • services/ — Business logic (auth verification, JWT, etc.).
  • middleware/ — Auth (ensureAuthenticated), CSRF, global error handler.
  • config/ — Constants, API paths, session config.

Key Flows

  • Auth: POST /api/session creates a cookie-backed session and DELETE /api/session ends it; legacy browser form paths remain available.
  • API key: Authenticated GET /api/key returns encryption key for client-side localStorage.
  • Pages: Most routes pass through to Vite; protected routes use ensureAuthenticated before passing.
  • Redirects: Legacy URLs are handled by config-driven rules in src/server/config/redirects.ts before page rendering. See docs/REDIRECTS.md.

See docs/ARCHITECTURE.md for the full system diagram, docs/AUTHENTICATION.md for auth details, and docs/API.md for API contract conventions.