Développement de l'API de Camino

gitlab-forge.din.developpement-durable.gouv.fr/pub/pnm-public/camino

Technologies

Guide de démarrage

Environnement

  • Node.js (v.10 ou plus) et npm
  • PostgreSQL (v.10 ou plus)

Configuration et imports des données

  • Cloner ce repo : git clone https://gitlab-forge.din.developpement-durable.gouv.fr/pub/pnm-public/camino.git.
  • Renommer le fichier .env-example en .env et le compléter.
  • Créer une base de données PostgreSQL correspondant au fichier .env.

Installation

# installe les dépendances
npm ci

Développement

# démarre le serveur
npm run dev -w packages/api

Production

# compile l'application avec typescript
npm run build -w packages/api

# démarre le serveur
npm run start -w packages/api

Structure des fichiers

.
│
└── src                  # `fichiers sources. Transformés avec npm run build.`
    ├── index            # `point d'entrée`
    │
    ├── api              # `APIs`
    │   ├── graphql      # `API Graphql`
    │   └── rest         # `API Rest`
    │
    ├── config           #
    │   ├── index        # `variables globales`
    │   └── knex         # `connexion à la base de données`
    │
    ├── database         # `base de données PostgreSQL`
    │   ├── models       # `modèles de la base de données (knex.js / objection.js)`
    │   └── queries      # `requêtes à la base de données (knex.js / objection.js)`
    │
    ├── business         # `logique métier`
    │   ├── processes    # `scripts de traitement`
    │   ├── rules        # `lois et procédures administratives`
    │   ├── utils        # `utilitaires de filtrage et de classement`
    │   ├── daily        # `scripts de mise à jour quotidiens (npm run daily)`
    │   ├── etape-update # `script effectués lors de la mise à jour d'une étape`
    │   └── monthly      # `scripts de mise à jour mensuels (npm run monthly)`
    │
    ├── knex                 # `scripts de migration et d'import de la base de données
    │   ├── migrations       # `migration de la base de données`
    │
    └── tools            # `outils`
        ├── export       # `exportation de la base de données vers des spreadsheets (npm run export)`
        ├── import       # `import de spreadsheets vers des fichiers json dans /sources (npm run import)`
        ├── api-...      # `connexion aux api externes`
        └── emails-send  # `envoi d'email`

Contribution

Voir contributing.md (en anglais) pour plus d'infos.