Skip to content

Latest commit

 

History

History
169 lines (126 loc) · 5.03 KB

README.md

File metadata and controls

169 lines (126 loc) · 5.03 KB
Raw

TFE21-232# EPL21-232

Table des matières
  1. A propos
  2. Guide de démarrage
  3. Utilisation
  4. Licence
  5. Contact
  6. Remerciements

A propos

Cette application a été concue par deux étudiants ingénieurs belges dans le cadre de leur mémoire. Ce travail a été le fruit d'un partenariat entre l'Université de Louvain-La-Neuve et l'Université d'état d'Haïti. Ce projet a pour mission d'aider la population haïtienne à accéder aux données pluviométriques à l'aide d'une carte interactive du pays affichant les différentes stations pluviométriques.

Vous trouverez premièrement une carte interactive d'Haïti sur laquelle vous distinguerez les différentes stations répertoriées. Vous aurez aussi l'opportunité de comparer les différentes données présentes sur notre site web et de réaliser des statistiques au travers de tableaux comparatifs et de graphiques qui seront à votre disposition.

Développé avec

Guide de démarrage

Les prérequis pour cette application sont légers et se limitent à avoir Make et Docker ( Engine + Compose ) installés au préalable.

Prérequis

Make

  • make ( sous MacOS ou Linux) 
    brew install make
  • make ( sous Windows) 
    scoop install make

Docker Engine

Rendez-vous sur le site officiel de Docker Engine, à l'adresse: https://docs.docker.com/engine/install/. Pour Windows/MacOS, vous pourrez simplement installer l'application Docker desktop, tandis que pour Linux, différents fichiers d'installation (.deb ou .rpm) sont disponibles à l'adresse précédente.

Docker Compose

Enfin, il vous suffira de finir par installer Docker Compose, dont les détails selon les systèmes d'exploitation sont disponibles à l'adresse: https://docs.docker.com/compose/install/. Il s’agit de l’adresse officielle du guide d’installation de Docker Compose. Un autre lien utile de Compose propre au framework que nous utilisons, Django, est: https://docs.docker.com/compose/django/

Installation

  1. Obtenez une clef d'API gratuite aurpès de SendGrid
  2. Clonez le répertoire 
    git clone https://github.com/nverbois/TFE21-232.git
  3. Construisez l'application 
    Make build
  4. Entrez votre clef d'API dans EPL21232/settings.py 
    SENDGRID_API_KEY = 'ENTREZ VOTRE CLEF API';

Utilisation

  • Construire l'application (la première fois)

    make build

  • Lancer l'application

    make compose-start

  • Arrêter l'application

    make compose-stop

  • Créer un super-utilisateur

    make compose-manage-py cmd="createsuperuser"

  • Créer les migrations de la base de données

    make compose-manage-py cmd="makemigrations"

  • Appliquer les migrations

    make compose-manage-py cmd="migrate"

  • Ouvrir le Shell de PostGreSQL

    docker-compose exec postgres psql -U postgres

  • Lister les volumes de Docker

    docker volume ls

  • Remettre à zéro la base de données

    docker volume rm tfe21-232_db-data

  • Lancer les tests unitaires

    make compose-manage-py cmd="test EPL21232.apps.data.tests"

Licence

Ce projet est distribué sous licence MIT. Consultez la section LICENSE pour plus d'informations.

Contact

Nicolas Verbois - [email protected]

Florian Duprez - [email protected]

Project Link: https://github.com/nverbois/TFE21-232

Remerciements