Dataviz finances Gironde

Contribuer

Au vu du scope du projet et de sa spécificité franco-française, il est décidé que le readme, les issues, pull requests et messages de commit sont à écrire en français.

Le code et les commentaires sont à écrire en anglais.

Compatibilité navigateur

Minima:

• IE11
• Edge
• Firefox
• Chrome
• navigateurs mobiles

Installer le projet

L'installation de node@>=6 est nécessaire avant de continuer.

Il faut (forker et) cloner ce dépôt pour procéder à l'installation des dépendances du projet :

npm install

La commande suivante reconstruit les builds en continu, dès qu'un fichier source est modifié :

npm run watch

Enfin, les composants web sont visualisables dans un navigateur web :

npm start

Deux adresses sont ensuite accessibles : http://localhost:3000/ et http://localhost:3000/public/.

Intégration continue

L'intégration continue est automatise les éléments suivants :

• exécution des tests sur chaque branche ;
• déploiement de la démo depuis master ;

Le suivi des builds est assuré par Travis CI.

Installation

En se rendant sur Travis CI :

1. se connecter avec son compte GitHub (Sign in with Github) ;
2. se rendre sur son profil Travis CI ;
3. cocher la case du projet datalocale/dataviz-finances-gironde.

Reste ensuite à configurer l'outil.

Configurer Travis CI

Deux variables d'environnement doivent être configurées dans l'onglet Settings :

| Name | Value | Display value in build logs | | --- | --- | --- | | GH_TOKEN | voir Générer un token | Off | | DEPLOY_TARGET_BRANCH | gh-pages | On |

Générer un token

Un Personal access token est nécessaire pour que l'automate d'intégration continue puisse publier la démo.

🔓 Générer un nouveau token

Le token créé est à renseigner dans la configuration Travis CI.

Déploiement

Remarque : les étapes de la section Installer le projet doivent avoir été suivies au préalable.

Il existe 3 environnements :

• gironde.fr où il faut créer manuellement dans le CMS un "media dataviz" et un contenu de type "Code HTML5" où on peut mettre le contenu de build/gironde-fr-integration.html. Le fichier JavaScript dataviz-finance-gironde-fr-bundle.script est à ajouter indépendamment.
  • npm run build-preprod pour la preprod (media id 1938)
  • npm run build-production pour la preprod (media id 2459)
• démo sur gh-pages (npm run build-demo:public mais cette commande est seulement faite par Travis)
• dévelopement (npm run watch)

Les artéfacts de build sont rendus créés dans le dossier ./build.

Convertir l'image de fond de la page d'accueil

Cette action requiert ImageMagick et est à effectuer à chaque fois que l'image images/Map-v1.jpg est mise à jour.

$ convert images/Map-v1.jpg -interlace Plane -resize 1300 -strip images/map-optimised.jpg

Licence

MIT