Files
..
2026-08-28 08:35:58 +00:00
2026-08-28 08:35:58 +00:00
2026-08-28 08:35:58 +00:00

CRUX Architecture

System-level docs and stack-scoped convention guides. Built-in feature docs live in docs/core/, project-module docs in docs/modules/, single-app docs with the app (apps/<app>/Readme.md).

Stack Guides

Guide Applies to
React frontend architecture Frontend apps and frontend modules under apps/*
Backend architecture AdonisJS backend apps and backend modules
Next.js web architecture The public website (apps/web/)

System Overview

App Source Stack Role
Backend API apps/backend/ AdonisJS v6 REST API, business logic, database, authorization
Admin frontend apps/admin/ React (Vite) Admin panel: core modules, devtools, project modules
Public website apps/web/ Next.js Server-rendered public site fed by the public API
┌──────────────────┐   authenticated REST    ┌──────────────────────┐
│  Admin (React)   │────────────────────────►│  Backend (AdonisJS)  │
│  apps/admin      │◄────────────────────────│  apps/backend        │
└──────────────────┘          DTOs           └──────────┬───────────┘
                                                        │
                                     public REST +      │  cache purge
                                     revalidation hooks │  webhooks
                                                        ▼
                                          ┌──────────────────────────┐
                                          │  Public site (Next.js)   │
                                          │  apps/web                │
                                          └──────────────────────────┘

Apps share contracts, never runtime code:

Feature-scoped contracts (DTOs, cache tags, env vars) live next to the feature in docs/core/<feature>/integration.md.

Shared Packages

packages/ holds @crux-kit/* packages shared across apps. Each documents itself in its own Readme.md; see the Packages index.