Documentation CoMobi

CoMobi

Page de présentation de CoMobi déployée avec Github pages.

Cette documentation est en cours de

Installation d'une nouvelle instance

Comment déployer une nouvelle instance de CoMobi et la rendre disponible depuis une URL publique.

1. Créer un compte github

2. Forker le dépôt neutre.comobi.fr

Faire une copie du dépôt neutre.comobi.fr sur votre compte Github.
Changer le nom dépôt (dans les paramètre du dépôt)

Note : les fork permettent de pouvoir récupérer un projet à un instant t (avec toute son histoire) et de le modifier sans modifier le projet de base. Les modifications du fork n'impacteront pas le projet de base et inversement.

Dans le contexte de CoMobi qui est sous licence MIT, permet à n'importe qui de copier le projet et de le rendre public ou non et nous ne sommes plus responsables de cette nouvelle version.

neutre.comobi.fr est le dépôt de l'instance neutre utilisé comme base de démonstration de l'outil CoMobi.

3. Déployer l'application chez un hébergeur

Nous avons choisi d'utiliser CleverCloud une entreprise Française, car ils nous permettent de déployer l'application sur des serveurs en France.

a. Créer un compte sur CleverCloud

b. Créer une application

sélectionnez le dépôt que vous venez de créer
sélectionnez Node comme type d'application
choisir nano comme taille (au moins 512mb)
choisir une serveur en France
aucun service supplémentaire n'est nécessaire
ajouter les variables d'environnements :

Nom	Description
GOOGLE_API_KEY	clé d'API google permettant à l'application d'accéder au fichier google
GOOGLE_DRIVER_SPREADSHEET_ID	identifiant de tableur google stockant les trajets lié au formulaire d'inscription

dans "Information"
- "Branche Github utilisée pour le déploiement" > modifier la branche github qui est déployée et utiliser deploy (cf doc sur le déploiement automatisé)
- cochez Forcer HTTPS
- cliquez sur Sauvegarder

c. Lié le dépôt github à l'application clevercloud

cloner en local et ajouter un remote

$ git clone <nom du dépôt dans lequel le fork a été fait>
$ git remote add clever git+ssh://[email protected]/app_462b421a-8932-4cb0-83c9-fe6a49faea83.git

Créer une variable JEKYLL

Dans votre dépôt dans Settings Cliquez dans le menu à gauche Secrets > Actions Puis, sur le bouton en haut à gauche pour créer une nouvelle clé secrette Nom : JEKYLL_PAT Valeur : un mot de passe sécurisé Enregistrer

Pousser la branche deploy sur le remote clever

$ git push clever branch:deploy

Où trouver ma clé d'API Google ?

Créer un projet dans la console Google
Dans le menu à gauche cliquez sur > API et Services > Identifiant
- Cliquez sur "Créer des identifiant" > "Clés API"
- Copiez la clé créée et la copier comme variable d'environnement GOOGLE_API_KEY dans CleverCloud

4. Gestion des données

a. Créer un compte Google

b. Créer le formulaire pour les propositions des trajets

copiez le formulaire de neutre.comobi
récupérer l'adresse du formulaire
- cliquez sur "Envoyer"
- Cliquez sur le second icône (partager)
- copier le lien dans le fichier de configuration _config

c. récupérer l'identifiant du tableau des réponses

ouvrir les droits du tableur des réponses à n'importe qui possédant l'URL du tableur :
- dans l'onglet réponse du formulaire cliquer sur l'icône "tableur" : le tableur devrait s'ouvrir
- en cliquant sur "partager" en haut à droite du document, une nouvelle fenêtre s'ouvre permettant de gérer les droits d'accès
- dans l'url du fichier récupérer l'identifiant du document à utiliser comme variable d'environnement GOOGLE_DRIVER_SPREADSHEET_ID -> https://docs.google.com/spreadsheets/d/<ID_A_COPIER>/

https://docs.google.com/spreadsheets/d/1LtRgQlsF-_oz6Us3AtpdNK-0bN0de5iV1Rug09F5y6w/edit?usp=sharing

note 1 : vous pouvez changez l'intitulé des questions, mais si vous ne souhaitez pas adapter le code correspondant au traitement des réponses il est nécessaire de garder la consitance des données. Par exemple : la colonne destinée à recevoir le départ doit rester cohérent

note 2 : la gestion des données est amenée à changer

5. (optionnel) Créer un tableur avec une liste de lieux précis

Dans le formulaire de recherche vous pouvez ajouter des noms de lieux qui ont du sens et une utilité pour votre contexte. Pour cela :

copier le format de ce tableau dans un nouveau fichier
ajouter l'identifiant du fichier https://docs.google.com/spreadsheets/d/<IDENTIDIANT>/edit#gid=0 dans le fichier _config.yml pour l'attribut liste_noms_locaux_lieux

Customiser son instance

Grâce au fichier de configuration _config.yml vous pouvez customiser différents éléments du site. Copiez le fichier _config.example.xml en remplaçant le fichier _config.yml de votre dépôt.

Mettre à jour son instance

betagouv / comobi Goto Github PK

comobi's Introduction