Skip to content

Latest commit

 

History

History
109 lines (72 loc) · 3.36 KB

developpement.md

File metadata and controls

109 lines (72 loc) · 3.36 KB
Raw

Développement

Organisation des dossiers

  • Le dossier /.infra contient la configuration de l'instructure.
  • Le dossier /.github contient l'ensemble des Github Actions.
  • Le dossier /server contient l'ensemble de l'application coté serveur, à savoir l'API Node Express.
  • Le dossier /shared contient le code partagé entre l'ui et le server
  • Le dossier /ui contient l'ensemble de l'application coté front, à savoir le code NextJs.
  • Le fichier /docker-compose.yml va définir la configuration des services de l'application, pour plus d'informations sur Docker cf: https://docs.docker.com/

Opérations

Veuillez consulter le README principal pour le démarrage.

Installation et Mise à jour des dépendences

Pour installer et mettre à jour les dépendences, vous pouvez au choix:

  • Modifier les différents package.json et appliquer les changements via yarn install
  • Ajouter des dépendences via la commande yarn add -E

Linter

Un linter (via ESLint) est mis en place dans le projet, pour le lancer :

yarn lint

Note: eslint est run automatiquement à chaque commit

Prettier

Prettier est mis en place dans le projet, pour le lancer :

yarn prettier:fix

Note: eslint est run automatiquement à chaque commit

Typescript

L'application utilise TypeScript, pour vérifier que les erreurs liés au type veuillez lancer:

yarn typecheck

Arrêt des services

Il est possible de stopper les services en lancant la commande suivante :

yarn services:stop

Suppression des services

Pour supprimer l'ensemble des services et tuer tous les conteneurs il suffit de lancer la commande suivante :

yarn services:clean

Server CLI

La cli du server s'éxécute sur le fichier compilé server/dist/index.js ainsi il est nécéssaire de:

  • soit avoir la commande dev lancée pour watch les changements
  • soit build avec la commande build:dev dans /server

Commandes:

  • yarn cli --help: List l'ensemble des commandes disponibles
  • yarn cli seed: Seed de la database
  • yarn cli migrations:status: Vérification du status des migrations
  • yarn cli migrations:up: Execution des migrations
  • yarn cli migrations:create: Creation d'une nouvelle migration

Emails

Le server SMTP de test Mailpit est utilisé localement pour prendre en charge l'envoi d'emails localement.

Vous pouvez accéder à l'interface utilisateur à l'addresse suivante http://localhost:8025.

Debugger sous VSCode

Il est possible de débugger facilement sous VSCode grace à la configuration Vscode partagée.

Server Inspect

  • Lancer la task Attach Server
  • Lancer l'application en utilisant la commande make debug au lieu de make start.