Skip to content

Latest commit

 

History

History
74 lines (55 loc) · 1.95 KB

contribution.md

File metadata and controls

74 lines (55 loc) · 1.95 KB

Contribution

Avant toutes contributions à ce projet merci de bien vouloir lire:

Environnement de développement

L'environnement de développement est basé de deux conteneurs docker. Ils fournissent une base de données et une API REST.

Prérequis

  • docker
  • docker-compose
  • npm

Installation

  1. Cloner le dépôt
  2. Lancez les conteneurs docker
docker compose --env-file=.env.dev -f compose.dev.yaml up -d
  1. installer les dépendances
npm i

Lancer l'application

  1. Avoir fait l'installation
  2. Lancer l'application
npm run dev
  1. Ouvrir un navigateur à l'adresse http://localhost:3000

lancer les tests

  1. Avoir fait l'installation
  2. Lancer les tests
npm run test

Tagger les nouveaux fichiers avec une licence

Fichier de code

docker run --rm --volume $(pwd):/data fsfe/reuse annotate --copyright INRAE --copyright-prefix string-symbol --contributor "prénom_nom <e-mail>" --license MIT --fallback-dot-license --merge-copyrights chemin_du_fichier

Fichier de documentation

docker run --rm --volume $(pwd):/data fsfe/reuse annotate --copyright INRAE --copyright-prefix string-symbol --contributor "prénom_nom <e-mail>" --license CC-BY-NC-4.0 --fallback-dot-license --merge-copyrights chemin_du_fichier

Un logo

docker run --rm --volume $(pwd):/data fsfe/reuse annotate --copyright INRAE --copyright-prefix string-symbol --contributor "prénom_nom <e-mail>" --license CC-BY-NC-ND-4.0 --fallback-dot-license --merge-copyrights chemin_du_fichier

Vérifier la conformité de la réutilisation

docker run --rm --volume $(pwd):/data fsfe/reuse --include-submodules lint