SOS Mediterranée Dashboard

Présentation du projet

TODO

Lancer le projet en local

Afin de lancer le projet en local, il est nécessaire d'avoir différents outils installés :

• NodeJS (version 16.14.0 latest LTS version 13/03)
• Git
• un EDI, par exemple VSCode

Ensuite, il faut cloner ce répertoire sur son ordinateur afin de travailler dessus en local.

Voici quelques conseils:

• EDI =>
  • Remplacer les tabulations par des espaces
  • Faire en sorte qu'une tabulation équivaut à deux espaces Ces paramètres se règlent dans les EDI facilement (n'hésitez pas à demander en précisant votre EDI si besoin), et ils permettent d'avoir la même forme peu importe qui a contributé et quand. (Après on peut discuter sur le nombre d'espace, deux me parait bien et suffisant)
• CSS =>
  • Utiliser TailWindCSS (au maximum) pour créer la mise en page, ce sont des classes à ajouter aux éléments HTML afin de créer les styles souhaités
  • Penser l'interface pour les mobiles en premier (mobile-first), et adapter aux écrans plus grands
• VueJS =>
  • La version utilisée est la 3, ce qui amène des nouveautés (notamment l'API composition)
  • Utilisation de SFC (Fichier unique pour le composant), ce qui signie que les fichiers '.vue' regroupent l'HTML (template), le TypeScript et le CSS (préféré utilisé TailWindCSS)

Règles de nommage:

• Fichier '.vue', nom des classes = PascalCase
• Classes CSS, nom des évènements dans l'HTML = kebab-case
• Nom des fonctions en TS et dans l'HTML = camelCase

N'oublier pas de vérifier les erreurs et avertissements grâce à l'analyse statique (lint) du code source, ce sont des règles standards d'écriture du TypeScript.

Installation des dépendances du projet:

npm install

Configuration du projet

À la racine du projet, vous avez besoin d'un fichier .env.local. Créez-le et écrivez dedans la ligne suivante : VUE_APP_GOOGLE_API_KEY=**HERE GOES YOUR GOOGLE API KEY**

Si vous n'avez pas de Google clé API, il faut en créer une ici.

Vous aurez besoin d'activer Google Sheets API ici. Il est conseillé de restreindre votre clef à Google Sheets API par sécurité.

Compilation et rechargement à la volée pour le développement

npm run serve

Compilation et minification pour la production

npm run build

Analyse statique et correction du code source

npm run lint

Customize configuration

See Configuration Reference.

Convention de codage

TODO

Contribution

TODO

English part ?

Project setup

npm install

Configure the project

At the root of the project, you need a .env.local file. Create it and write to it the following line: VUE_APP_GOOGLE_API_KEY=**HERE GOES YOUR GOOGLE API KEY**

If you don't have one yet, you need to create one here.

You need to enable Google Sheets API ici. It is recommended to restrict your key to Google Sheets API for security.

Compiles and hot-reloads for development

npm run serve

Compiles and minifies for production

npm run build

Lints and fixes files

npm run lint

Customize configuration

See Configuration Reference.

TODO =>

• écrire une convention de codage
• recommandation pour les EDI => espaces au lieu de tabulation et nombre d'espaces pour une tabulation
• code de conduite/recommandation pour PR
• configuration de git
• mettre en place une base (vue-cli, tailwindcss, typescript, autres ?)
• écrire les différentes commandes afin de lancer le projet
• créer une autre branche develop
• s'amuser !