marcelle-mobi

Déplacez-vous autrement dans Marseille

SETUP

1. Installer ou upgrader vers NodeJS 10 https://nodejs.org/fr/download/

Mac OS (avec homebrew)

brew install node
**OR**
brew update
brew upgrade node

Linux (avec apt)

curl -sL https://deb.nodesource.com/setup_10.x | sudo -E bash -
sudo apt install nodejs

2. Installer Yarn (gestionnaire de packages) https://yarnpkg.com/en/docs/install

Mac OS

brew install yarn

Linux

curl -sS https://dl.yarnpkg.com/debian/pubkey.gpg | sudo apt-key add -
echo "deb https://dl.yarnpkg.com/debian/ stable main" | sudo tee /etc/apt/sources.list.d/yarn.list
sudo apt-get update && sudo apt-get install yarn

Un éditeur de code : https://code.visualstudio.com/

OPTION 1 : Travailler dans l'application existante

En VueJS exemple pour ajouter une page dans l'app

VueJS+JSX exemple en JSX

HTML+CSS+JS exemple Vanilla

1. Forker le repo Aide
2. Cloner votre repo

Cloner votre repo

git clone [email protected]:VOTRE_USERNAME_GITHUB/marcelle-mobi.git
cd marcelle-mobi
yarn install

Ajouter un fichier nommé .env à la racine du dossier de votre application, qui contient :

CODE4MARSEILLE_API_KEY=code4marseillefrioul

Lancer le serveur en local sur http://localhost:3000

yarn dev

3. Créer une branche git checkout -b ma-super-feature
4. A la fin du Hackathon : pousser votre branche sur Github et faire une Pull Request vers ce repo KevinBerthier/marcelle-mobi

OPTION 2 : Créer votre propre projet

1. Créer un projet avec le langage de votre choix
2. Créer un repo Github Aide
3. Mettre le projet en ligne (par exemple sur https://heroku.com/ ou avec https://ngrok.com/ ou https://localtunnel.github.io)
4. Me transmettre l'url de votre repo et de l'app

ACCÈS API

DOCUMENTATION : https://documenter.getpostman.com/view/6818477/SVtR3r1b

Pour chaque requête il est nécessaire de passer le grant_token fourni en params. Ex: http://marcelle-mobi-api.herokuapp.com/airs/quality?grant_token=code4marseillefrioul

Vous êtes libre d'utiliser d'autres sources de données. Je vous conseille de parcourir https://www.datasud.fr/

Librairies utilisées

Voir Package.json

Les Docs :

• https://fr.vuejs.org/index.html
• https://fr.nuxtjs.org/
• https://github.com/axios/axios (utilisation possible via Nuxt https://axios.nuxtjs.org/)
• https://leafletjs.com/ (utilisation possible via VueJS https://github.com/KoRiGaN/Vue2Leaflet)

Docs UI :

• https://getbootstrap.com/docs/4.3/getting-started/introduction/ (Pour le CSS)
• https://bootstrap-vue.js.org/ (Pour le JS)
• https://fontawesome.com/icons?d=gallery

Bon Hackathon !