Skip to content

Commit

Permalink
Merge branch 'master' of https://github.com/IGNF/geoportal-sdk
Browse files Browse the repository at this point in the history
  • Loading branch information
pjjmunier committed Dec 20, 2017
2 parents 23daa2a + d21d763 commit a49944a
Show file tree
Hide file tree
Showing 23 changed files with 8,446 additions and 1,016 deletions.
21 changes: 21 additions & 0 deletions .npmignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
/doc
/lib
/res
/_site
/src
/test
/samples
/utils
/target
.*
build.sh
CHANGELOG*
CONTRIBUTING.md
COMPILE.md
gulpfile.js
jsdoc.json
*.gz
*.tgz
*.sh
*.txt
*.log
6 changes: 3 additions & 3 deletions LICENCE.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,9 @@ Copyright (c) 2016 IGN

The Geoportal SDK includes the following third party code :

### OpenLayers 3
### OpenLayers

Copyright 2005-2016 OpenLayers Contributors. All rights reserved.
Copyright 2005-2017 OpenLayers Contributors. All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

Expand All @@ -33,7 +33,7 @@ THIS SOFTWARE IS PROVIDED BY OPENLAYERS CONTRIBUTORS ``AS IS'' AND ANY EXPRESS O
The views and conclusions contained in the software and documentation are those of the authors and should not be interpreted as representing official policies, either expressed or implied, of OpenLayers Contributors.


### Geoportal extension for OpenLayers 3
### Geoportal extension for OpenLayers

This software is released under the licence CeCILL-B (Free BSD compatible)

Expand Down
29 changes: 26 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,12 +17,12 @@ Il s’adresse à des gestionnaires de site internet désireux de proposer rapid

### Téléchargement

Vous pouvez récupérer le Kit de Développement Géoportail [ici](https://github.com/ignf/geoportal-sdk/releases/download/v1.0.0-beta.1/GpSDK.zip).
Vous pouvez récupérer le Kit de Développement Géoportail soit par [téléchargement direct](#download-direct), soit en utilisant le [gestionnaire de dépendances javascript NPM](#download-npm).


Il contient l'arborescence suivante :

sdk-ol3/
<Kit de Développement Géoportail>/
GpOl3.js
(version minifiée du code javascript pour une utilisation en production)
GpOl3.css
Expand All @@ -35,10 +35,33 @@ Il contient l'arborescence suivante :
(resources images utilisées par les fichiers CSS)


<a id="download-direct"/>

#### Téléchargement direct

Vous pouvez télécharger la dernière version du Kit de Développement Géoportail directement sur [la page Github des releases du SDK](https://github.com/IGNF/geoportal-sdk/releases).

L'archive téléchargée (GpSDK.zip) comprend l'arborescence décrite ci-dessus.


<a id="download-npm"/>

#### Récupération avec NPM

Le Kit de Développement Géoportail est aussi disponible dans les dépôts [NPM](https://www.npmjs.com/package/geoportal-sdk).

Prérequis : [NodeJS](https://nodejs.org/en/) et [npm](https://www.npmjs.com/) installés.

```
npm i geoportal-sdk
```

L'arborescence décrite ci-dessus sera alors accessible dans le répertoire `node_modules/geoportal-sdk/dist/ol3/` de votre projet.


### Intégration dans une page web

Dézippez le SDK géoportail dans l'arborescence de votre serveur web. Vous pouvez positionner à votre guise les fichiers css et javascript. Le répertoire img doit cependant être positionné au même niveau que le fichier css pour que les ressources images qui y sont référencées soient correctement chargées.
Placez les fichiers du SDK géoportail dans l'arborescence de votre serveur web. Vous pouvez positionner à votre guise les fichiers css et javascript. Le répertoire img doit cependant être positionné au même niveau que le fichier css pour que les ressources images qui y sont référencées soient correctement chargées.

Intégrez le SDK géoportail dans votre page web classiquement à l'aide d'une balise **script** pour charger le fichier javascript et d'une balise **link** pour charger le fichier css.

Expand Down
2 changes: 2 additions & 0 deletions build.sh
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,8 @@ function itowns() {
gulp publish
}

npm install

while getopts "aoi" opts
do
case $opts in
Expand Down
Loading

0 comments on commit a49944a

Please sign in to comment.