Référentiel des applications

Un projet visant à cataloguer et gérer les informations sur les applications utilisées au sein du ministère de l'Intérieur. L'objectif est de fournir un point de vérité unique pour répertorier et gérer les métadonnées de ces applications.

📚 Table des matières

• Référentiel des applications
  • 📚 Table des matières
  • Technologies Utilisées
  • Prérequis
  • 🚀 Installation et Démarrage
    • 1. Cloner le dépôt
    • 2. Démarrer les services Docker
    • 3. Configurer le Backend
    • 4. Configurer le Client (Frontend)
  • 🛠️ Accès Administrateur en Mode Développement
  • Commandes Utiles
    • Voir les logs en direct
    • Arrêter l'environnement
  • 🧪 Lancer les Tests
  • 🤝 Contribution
    • Workflow de Contribution
    • Conventional Commits
  • 📄 Licence

Technologies Utilisées

• Backend : NestJS avec TypeScript
• Base de données : PostgreSQL
• ORM : Prisma
• Conteneurisation : Docker & Docker Compose

Prérequis

Avant de commencer, assurez-vous d'avoir installé les outils suivants sur votre machine :

• Docker
• Git

🚀 Installation et Démarrage

Suivez ces étapes pour lancer l'environnement de développement complet.

1. Cloner le dépôt

git clone https://github.com/dnum-mi/referentiel-applications.git
cd referentiel-applications

2. Démarrer les services Docker

Cette commande va construire les images des conteneurs (si nécessaire) et les démarrer en arrière-plan.

docker compose up --build

3. Configurer le Backend

Exécutez ces commandes pour préparer la base de données et le client Prisma :

docker compose exec backend npx prisma generate
docker compose exec backend npx prisma migrate deploy
docker compose exec backend pnpm cmd user create -e [email protected] -a 30 # Permet de créer un utilisateur administrateur

4. Configurer le Client (Frontend)

Si votre projet inclut un frontend, cette commande génère le code nécessaire pour communiquer avec l'API backend :

docker compose exec client bash pnpm api:generate

🎉 Félicitations, l'environnement est prêt !

🛠️ Accès Administrateur en Mode Développement

Pour obtenir les droits administrateur en local:

1. Rendez-vous sur http://localhost:5555
2. Trouvez l’utilisateur à modifier dans l’interface dédiée
3. Ajustez le champ level pour lui donner le rôle admin (un niveau élevé correspond à l’admin)

Commandes Utiles

Voir les logs en direct

Pour suivre les logs de tous les services (backend, bdd, etc.) :

docker compose logs -f

Pour voir les logs d'un service spécifique (ex: backend) :

docker compose logs -f backend

Arrêter l'environnement

Pour arrêter et supprimer les conteneurs :

docker compose down

🧪 Lancer les Tests

Pour exécuter la suite de tests automatisés du backend :

docker compose exec backend pnpm test

Les tests unitaires se trouvent dans le dossier /backend/test. Pour ajouter un test, créez un fichier .spec.ts dans ce dossier.

🤝 Contribution

Workflow de Contribution

1. Créez une branche depuis main en suivant la convention de nommage :

   # Pour une nouvelle fonctionnalité
   git switch -c feature/nom-de-la-feature
   
   # Pour une correction de bug
   git switch -c fix/nom-du-fix

2. Assurez-vous que votre code respecte les normes de formatage avant de commit :

   pnpm run format

3. Avant de soumettre une PR :

   • Vérifiez que tous les tests passent
   • Vérifiez que le code est correctement formaté

Conventional Commits

Nous suivons les Conventional Commits pour garantir la cohérence et faciliter le versionnement. Le format est validé automatiquement avant chaque commit grâce à Husky et Commitlint.

Exemples :

• feat(auth): add login functionality
• fix(ui): correct button alignment
• docs(readme): update installation instructions
• refactor(api): simplify user query
• ci(docker): optimize build process

📄 Licence

Ce projet est sous licence MIT. Voir le fichier LICENSE pour plus de détails.

MIT License