Files
AuditShield/CLAUDE.md
2026-03-21 16:04:40 +00:00

1.9 KiB

[NOM DU PROJET]

Projet

[Une phrase : ce que fait l'app, pour qui, pourquoi.]

Stack

  • Runtime : Node 20 / Python 3.11 / ...
  • Framework : ...
  • Base de données : MariaDB / PostgreSQL / SQLite
  • Déploiement : Docker → Synology NAS (rigolet.tech)

Structure

src/
  components/   # Exemple de composant : src/components/UserCard.tsx
  api/          # Exemple de route : src/api/users/route.ts
  stores/       # State management
docker/
  docker-compose.yml
.gitea/
  workflows/
    deploy.yml

Commandes

npm install       # Installer les dépendances
npm run dev       # Lancer en développement
npm run build     # Build production
npm test          # Lancer UN test ciblé, pas toute la suite
npm run typecheck # IMPORTANT : lancer après chaque série de modifications

Code style

  • ES modules (import/export), jamais CommonJS (require)
  • Functional components + hooks uniquement, jamais de class components
  • TypeScript strict activé
  • Destructure les imports quand possible
  • IMPORTANT : ne jamais considérer une tâche terminée sans typecheck qui passe

Git

  • Branches : main (prod) → dev (dev)
  • Commits : feat: / fix: / docs: / refactor: / chore:
  • IMPORTANT : toujours créer une nouvelle branche pour chaque tâche
  • IMPORTANT : ne jamais pusher directement sur main

Déploiement

Pipeline automatique via Gitea Actions. Chaque push sur develop déclenche un déploiement sur le NAS. Voir @.gitea/workflows/deploy.yml pour le détail du pipeline.

Références

  • Vue d'ensemble du projet : @README.md
  • Variables d'environnement : @.env.example

Ce que Claude doit savoir sur CE projet

  • [Ajoute ici les erreurs que Claude répète spécifiquement sur ce projet]
  • [Ex : "ne pas utiliser axios, on utilise fetch natif"]
  • [Ex : "la BDD utilise snake_case, le code TypeScript utilise camelCase"]
  • [Ex : "les tests sont dans tests/, pas dans src/"]