Skip to content

README.md

Latest commit

 

History

History
39 lines (25 loc) · 1.52 KB

README.md

File metadata and controls

39 lines (25 loc) · 1.52 KB
Raw

IGNF/validator-api-client

License: AGPL-3.0

Description

Démonstrateur pour appel à l'API IGNF/validator-api.

⚠️ ce démonstrateur contient des éléments éditoriaux et une charte graphique propres à l'IGN. Il vous appartient de surcharger ces éléments si vous envisagez un déploiement public.

Fonctionnalités

  • Lancer une validation sur une archive ZIP en choisissant un standard
  • Visualiser le résultat d'une validation en connaissant son identifiant
  • Télécharger les résultats

Développement

npm install
# build en continu du front
npm run watch
# lancement du back
npm run start

Pour une nouvelle version, penser à mettre à jour le numéro de version dans le package.json et à reconstruire dist/validator-client.js :

npm run build

Usage

Ce démonstrateur est inclus dans IGNF/validator-api. Si toutefois vous souhaitez déployer séparément l'API et le démonstrateur, suivez les instructions dans la fiche intégration dans une application existante

Licence

Ce paquet est publié sous licence AGPL-3.0-or-later. Lorsqu'il est intégré comme dépendance d'une application tierce (par exemple le backend d'IGNF/validator-api), la compatibilité de cette licence avec le mode de distribution de l'application hôte est à valider par les équipes concernées.