Skip to content

Commit 6c74586

Browse files
Update README.md
1 parent b4f7208 commit 6c74586

File tree

1 file changed

+27
-9
lines changed

1 file changed

+27
-9
lines changed

README.md

Lines changed: 27 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,25 @@
1-
# PACA-API
1+
# Sitourisme (PACA-API)
22

3-
Outil nécéssaire :
4-
- NodeJS 14+
5-
- Docker et docker-compose
3+
Passerelle permettant d'importer automatiquement des itinéraires depuis l'API d'instances Geotrek-admin vers Apidae.
4+
5+
- Fonctionnement et correspondance des champs : https://geotrek.ecrins-parcnational.fr/ressources/technique/2022-04-Geotrek-Apidae-v2.pdf
6+
- Présentation aux rencontres Geotrek 2021 : https://geotrek.ecrins-parcnational.fr/rencontres/2021/presentations/09-geotrek-apidae.pdf
7+
8+
Afin de mettre en place la passerelle, il est nécessaire :
9+
- de créer un projet d'API en écriture sur la plateforme Apidae en indiquant les prestataires
10+
- de fournir les éléments suivants :
11+
- URL du flux API Geotrek
12+
- Numéro du projet créé sur la plateforme Apidae avec envoi des clef et secret Oauth
13+
- Pour chaque identifiant de structure Geotrek, fournir l'identifiant de l'ENT correspondant dans Apidae
14+
15+
Version 1 financée par la [Région Sud](https://www.maregionsud.fr), développée par [IDfr](https://www.idfr.net) et [MEDIACTEURS](https://www.mediacteurs.com).
16+
17+
## Installation
618

7-
## installation
19+
Outils nécessaires :
20+
21+
- NodeJS 14+
22+
- Docker et Docker-compose
823

924
Créer la structure de dossier comme indiqué dans l'arbre en dessous :
1025

@@ -17,18 +32,21 @@ Créer la structure de dossier comme indiqué dans l'arbre en dessous :
1732
├── region.csv
1833
```
1934

20-
Les fichiers town.csv et region.csv se trouve dans le dossier data du projet, il faut les déplacer au bon endroit.
35+
Les fichiers `town.csv` et `region.csv` se trouvent dans le dossier `data` du projet, il faut les déplacer au bon endroit.
2136

2237
Dans le projet effectuer la commande d'installation :
2338

39+
```
2440
npm install
2541
```
2642

2743
## Usage
2844

29-
Afin de procéder à l'import des données il faut créer un compte utilisateur et intialiser le système d'import,
30-
pour cela se rendre sur cette page `http://localhost:3003/authentication/signup` et remplir le formulaire
45+
Afin de procéder à l'import des données, il faut créer un compte utilisateur et initialiser le système d'import,
46+
pour cela se rendre sur cette page `http://localhost:3003/authentication/signup` et remplir le formulaire.
3147

3248
Effectuer ensuite à commande `npm run init-import`
3349

34-
Les imports peuvent maintenant être effectué depuis l'interface.
50+
Les imports peuvent maintenant être effectués depuis l'interface, ou n accédans directement à l'adresse `http://URL/products/import/geotrek`
51+
52+
Les imports peuvent aussi être lancés automatiquement avec la commande `curl "URL/api/products/import?type=geotrek"`

0 commit comments

Comments
 (0)