/betagouv-catalog-services

Primary LanguageTypeScript

Installation/Démarrage du back et front

pnpm install
pnpm run dev

Architecture

Le projet est un monorepo utilisant les meilleures technologies dans l'écosystème Javascript

Source: https://2022.stateofjs.com/en-US/libraries/

Améliorations possible

Beaucoup d'améliorations peuvent être apportées dans ce projet:

Général

  • Faire de la documentation

Devops

  • Faire du CI/CD (pipeline de check de dépendances, tests unitaires etc..)
  • Utiliser dependabot pour mettre à jour les dépendances automatiquement en créant des PR
  • Utiliser semantic-release
  • Build une image docker
  • Utiliser SonarQube pour vérifier la qualimétrie du code

Script

  • Demander le chemin de sortie en paramètre
  • Supprimer la méthode fileExists et vérifier directement dans la méthode convert
  • Faire des tests d'intégrations avec des fichiers contenant beaucoup de services
  • Faire un test unitaire par rapport aux permissions des fichiers
  • Utiliser une architecture hexagonale afin d'être le plus abstrait possible afin de préserver les logiques métiers de l'application

API

Il n'y avait pas besoin d'utiliser Fastify mais le faire directement avec NextJS.

Front

  • Faire du responsive en mobile-first
  • Découper les composants beacoup plus finement
  • Implémenter le menu
  • Renommer le fichier CSS en global.module.css
  • Faire des tests

Objectifs

  • Réaliser une page web listant les différents services d'une mission.
  • Livrable
  • Une page web hébergée répondant aux spécifications ci-dessous
  • Une chemin d'url hébergé fournissant la liste des services réalisés au format JSON
  • Un script NodeJs créant un fichier JSON contenant la liste des services
  • Un repository github consultable opensource

Déploiement