Skip to content
Snippets Groups Projects
Commit 2a2efb4c authored by Gaelle.Barris's avatar Gaelle.Barris
Browse files

maj README

parent a1d1c441
Branches
Tags
No related merge requests found
......@@ -14,18 +14,22 @@ Le composant Javascript d-editmap est disponible sous forme de paquet NPM sous l
### Utilisation dans une application tierce
#### Installation
#### Utilisation via NPM
##### Installation
Pour installer le composant JS d-editmap dans un projet NPM :
```bash
$ npm install @descartes/d-editmap
```
Note : le paquet n'est pas disponible sur les dépôts public NPM (registry.npmjs.org), il faut donc faire pointer le scope `@descartes` sur le dépôt souhaité:
- dépôt public gitlab-forge (pour les versions diffusées) :
Note : le paquet est disponible sur différents dépôts, il faut donc faire pointer le scope `@descartes` sur le dépôt souhaité:
- dépôt public gitlab-forge (pour les versions diffusées au sein du ministère MTE) :
https://gitlab-forge.din.developpement-durable.gouv.fr/api/v4/projects/17127/packages/npm
- dépôt privé (pour les versions en cours de développement) :
https://gitlab-forge.din.developpement-durable.gouv.fr/api/v4/projects/18174/packages/npm
- dépôts public NPM (pour les versions diffusées "grand public" à accès CDN)
https://registry.npmjs.org
Pour que NPM puisse se connecter aux dépôts, il faut renseigner le fichier `.npmrc` :
```
......@@ -33,7 +37,7 @@ Pour que NPM puisse se connecter aux dépôts, il faut renseigner le fichier `.n
...
```
#### Inclusion du composant
##### Inclusion du composant
Tout d'abord, le chargement de la librairie principale Descartes est nécessaire:
le paquet `@descartes/d-map` doit être inclus dans l'application.
......@@ -43,15 +47,53 @@ Pour utiliser le composant JS d-editmap, il suffit d'inclure les fichiers suivan
* `d-editmap.js`
#### Utilisation du composant en cours de développement
#### Utilisation via CDN
Tout d'abord, le chargement de la librairie principale Descartes est nécessaire:
les urls CDN de `@descartes/d-map` doit être incluses dans l'application.
Pour utiliser le composant JS D-Map, il suffit d'inclure ensuite les fichiers suivants dans la page HTML de l'application :
* `https://cdn.jsdelivr.net/npm/@descartes/d-editmap@X.X.X/dist/css/d-editmap.css`
* `https://cdn.jsdelivr.net/npm/@descartes/d-editmap@X.X.X/dist/d-editmap.js`
Note : l'utilisation via CDN n'est pas recommandé en production.
### Pre-requis
### Utilisation du composant en cours de développement
#### Pre-requis
Installation sur son poste:
* NODE 16.14.0
* NPM 8.5.2
### Compilation
#### Utilisation de link
Il est possible de travailler simultanément sur le composant d-editmap et sur une application tierce, afin de vérifier
par exemple le bon comportement d'une évolution de d-editmap.
Pour cela, on commence par demander à npm de créer une référence locale globale du paquet, en se positionnant à la racine du projet d-editmap :
```
npm link
```
Ensuite, il faut indiquer à NPM que le paquet `@descartes/d-editmap` doit être résolu localement, en se positionnant dans le projet tierce :
```
$ npm link @descartes/d-editmap
```
Une fois les développements terminés, pour revenir à un état normal, en se positionnant dans le projet tierce :
```
npm unlink --no-save @descartes/d-editmap
npm install
```
Finalement, on peut demander à npm de nettoyer la référence locale globale, en se positionnant à la racine du projet d-editmap :
```
npm unlink
```
#### Compilation
La compilation du composant JS de d-editmap se fait à l'aide de Webpack. Par ailleurs le composant possède les dépendances suivantes :
* jsts
......@@ -67,7 +109,7 @@ Lors de la compilation, les fichiers suivants sont générés dans le répertoir
> ces fichiers sont générés par Webpack
* tous les autre fichiers (images, polices, ...) sont des ressources requises pour le bon fonctionnement du composant
### Développement du composant
#### Développement du composant
Pour lancer les exemples d-editmap :
```bash
......@@ -81,6 +123,6 @@ L'index des exemples est accessible sur http://localhost:4201. Les exemples se r
> Note : Le répertoire `dist` ainsi que les répertoires `/demo` et `/node_modules` sont rendus accessibles à la racine du serveur.
### Publication
#### Publication
La publication du paquet NPM se fait via GITLAB-CI à la création d'un TAG.
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment