Traveleef App

Présentation de l'application :

Traveleef est une solution qui vous permet d'optimiser chaque aventure tout en minimisant votre empreinte carbone. 🚆✨

En voyageant avec Traveleef, vous contribuerez à un avenir plus durable pour notre planète. Chaque petit geste compte, et c'est en utilisant des moyens de transport plus respectueux de l'environnement que nous pouvons faire la différence. 💪

Guide d'utilisatation

Prérequis : voir Guide d'installation

• Node.js installé (version LTS recommandée)
• Npm (gestionnaire de paquet Node, inclut avec Node.js)
• Git
• Docker (version LTS recommandée)
• VsCode (éditeur de code) ou IDE (Environnement de développement) comme Webstorm (pour coder sur le web) et Pycharm (pour coder en python) (optionnel)

Installation/Initialisation du projet :

1. Cloner le projet avec la commande : git clone <LIEN_DU_REPO_GITHUB>
2. Accéder au dossier du projet "Traveleef_app"
3. Ouvrir un terminal sur le même chemin que le dossier contenant le frontend Angular cd Traveleef_app/frontend/traveleef-app. Puis effectuer les commandes suivantes : npm install pour installer les dépendances Node, puis ng build pour construire l'application.
4. Ensuite, il faut également créer un fichier .flaskenv dans le dossier backend et y définir la configuration pour la base de données et le backend (clé api ect...).
5. Revenez au répertoire racine du projet "Traveleef_app" et exécutez la commande suivante dans le terminal pour démarrer le projet : docker compose up -d.

Information(s) utilitaire(s) :

• Pour accéder à l'application côté frontend, ouvrez votre navigateur et rendez-vous à l'adresse suivante : http://localhost:4200
• Le backend n'est pas directement accessible via le navigateur pour des raisons de sécurité. Toutefois, si vous souhaitez y accéder, vous pouvez configurer un port dans le fichier docker-compose.yml du backend afin de permettre un accès externe.
• La base de donnée est accessible depuis le terminal en utilisant la commande suivante : docker exec -it <ID_conteneur ou nom conteneur postgresql> psql -U <NOM_UTILISATEUR> -d <BASE_DE_DONNEE>. Cela vous permet de vous connecter au conteneur PostgreSQL pour interagir avec la base de données.
• Dans le fichier docker-compose.yml, nous vous recommandons de ne pas utiliser de mot de passe contenant des espaces, car cela pourrait entraîner des bugs sur le backend.

Voici un exemple du contenu dans un fichier .flaskenv :

FLASK_APP=
FLASK_ENV=
DB_USER=
DB_HOST=
DB_PORT=
DB_NAME=
API_KEY=