Aperoscope — Documentation technique
Aperoscope est un monorepo pnpm regroupant une API NestJS, un client React (Vite) et cette documentation Docusaurus. Le projet est conçu pour évoluer progressivement : la base de données Prisma est initialisée sans modèles, et seules les routes essentielles (health, metrics, exemple) sont en place.
Stack
| Couche | Technologie | Emplacement |
|---|---|---|
| API | NestJS 11 + Prisma | apps/backend |
| Client | React 19 + Vite 6 | apps/frontend |
| Documentation | Docusaurus 3 | apps/docs |
| Types partagés | Zod + TypeScript | packages/shared-types |
| Lint partagé | ESLint 9 (flat config) | packages/eslint-config |
Prérequis
- Docker (obligatoire pour le développement)
- Node.js 22.13+ et pnpm 11.11+ (pour lint, tests et hooks Git sur l'hôte)
Démarrage en 30 secondes
corepack enable
pnpm install
pnpm dev # backend :3000, frontend :3001, docs :3002 (tout en Docker)
Sections de cette documentation
| Section | Contenu |
|---|---|
| Démarrage | Installation, Docker, commandes |
| Architecture | Monorepo, flux, stack prod |
| Sécurité & Observabilité | Zod, rate limiting, Sentry, Pino, Prometheus |
| Backend | Conventions NestJS, modules, Prisma |
| Frontend | Conventions React/Vite, CSS Modules |
| Contexte LLM | Référence condensée pour assistants IA |
Contexte LLM (Cursor / Copilot)
Pour alimenter un assistant IA avec le contexte du projet, référencer le fichier CONTEXT.md à la racine du dépôt ou la page Contexte projet.
Liens utiles (dev Docker)
| Ressource | URL |
|---|---|
| API | http://localhost:3000 |
| Swagger | http://localhost:3000/docs |
| Frontend | http://localhost:3001 |
| Docs | http://localhost:3002 |
| RabbitMQ UI | http://localhost:15672 (guest / guest) |