README.md 2.25 KB
Newer Older
duduyo's avatar
duduyo committed
1
# Crater API
duduyo's avatar
duduyo committed
2

duduyo's avatar
duduyo committed
3
## Contribuer
duduyo's avatar
duduyo committed
4

5
Pré-requis :
duduyo's avatar
duduyo committed
6

7
8
1. Installer [nodejs](https://nodejs.org/en/download/) (version 10.0.2 ou supérieure)
2. Installer un [runtime java](https://nodejs.org/en/download/) si pas déjà présent
duduyo's avatar
duduyo committed
9

duduyo's avatar
duduyo committed
10
11
12
13
14
Puis :

1. Cloner le dépôt.
2. Dans le répertoire du dépot faire un `npm install`
3. Builder et lancer l'application avec `npm run run-prod`  
Benjam's avatar
Benjam committed
15
   L'api est accessible sur [localhost:3000](http://localhost:3000), par exemple à cette adresse http://localhost:3000/crater/api/communes/C-31069
duduyo's avatar
duduyo committed
16

17
18
19
20
21
22
23
24
25
26
27
## Tester

Pré-requis :

1. Clôner le dépôt `crater-data-resultats` dans `test/integration/donnees` (ou créer un lien symbolique)

Puis :

1. Lancer `npm run test` pour lancer tous les tests (unitaires + intégration)
2. Lancer `npm run unit-test` pour lancer uniquement les tests unitaires

duduyo's avatar
duduyo committed
28
29
30
31
32
33
34
35
36
37
## Livrer

L'application est déployée automatiquement sur les 2 environnements de développement et de production, via des pipelines gitlab définis dans le fichier [.gitlab-ci.yml](.gitlab-ci.yml)

1- Lors de chaque commit sur la branche develop, le code correspondand est poussé sur l'hébergeur o2switch. L'avancement et le résultat des pipelines est visible ici https://framagit.org/lga/crater-ui/pipelines

Une fois le pipeline terminé, pour que les modifications soient prises en compte, il est nécessaire de se connecter sur l'outils d'aministration o2switch pour remédarrer l'application nodejs.

Pour cela :

38
39
40
-   Connexion à cette adresse https://macaroni.o2switch.net:2083/
-   login/mdp du compte de l'association Les Greniers d'Abondance
-   Accéder à l'outil "Setup Node.js App", puis redémarrer l'application "dev.resiliencealimentaire.org/crater/api"
duduyo's avatar
duduyo committed
41

Benjam's avatar
Benjam committed
42
Il est ensuite possible de tester à l'api à cette adresse https://dev.resiliencealimentaire.org/crater/api/communes/C-31069 ou https://dev.resiliencealimentaire.org/crater/api/diagnostics/C-31069
duduyo's avatar
duduyo committed
43

Benjam's avatar
Benjam committed
44
45
2- Même fonctionnement sur la branche master, ou les mises à jour sont livrées sur l'environnement de production : https://crater.resiliencealimentaire.org
Dans ce cas, on peut tester avec cette url : https://crater.resiliencealimentaire.org/crater/api/communes/C-31069
duduyo's avatar
duduyo committed
46

47
Rq : La branche master est protégée, il n'est pas possible de commiter directement dessus, il faut passer par une merge request gitlab