Beyond Vision - Plateforme Web

Le but de notre projet est de créer une plateforme d'automatisation de la création de l'audiodescription fiable et rapide afin que les déficients visuels puissent avoir plus de contenu adapté à leurs besoins. Cette partie est consacrée à la plateforme web qui permettra aux utilisateurs d'effectuer de l'audiodescription le plus facilement possible.

Table of Contents

1. Les Technologies utilisées
2. Mise en route
   • Version de Développement
   • Version de Production
3. Contribution
4. Auteurs
5. License

Les technologies utilisées

Pour ce projet nous avons utilisé les technologies suivantes:

• MongoDb
• ExpressJs
• ReactJs
• NodeJs
• Docker

Mise en route

Pour les utilisateurs de Windows !!

Windows ajout souvant des '\r' dans certain fichier, ils peuvent empécher le build. Pour résoudre le problème il suffit de lancer la commande suivante:

foo@bar:~$ dos2unix .docker/mongo-express/docker-entrypoint.sh

Installer dos2unix

Configuration

Avant de lancer l'application il faudra creer plusieurs .env Le premier, celui du frontend devra contenir ces variables:

REACT_APP_API_URL="urltoapi"
REACT_APP_STRIPE_CLIENT_KEY=""
REACT_APP_S3_ID=""
REACT_APP_S3_SECRET=""
REACT_APP_S3_REGION=""

Le second, celui du backend devra contenir ces variables:

JWT_SECRETKEY="secretKeyToSignAndVerifyJWT"
DB_CONN_STRING="mongodb://nameOfDB:passwordOfDB@urlOfDb/nameOfCollection"
GMAIL_USERNAME="[email protected]"
GOOGLE_CLIENT_ID=googleCliendID
GOOGLE_CLIENT_SECRET=googleClientSecret
GOOGLE_REFRESH_TOKEN=googleRefreshToken
GOOGLE_ACCESS_TOKEN=googleAccessToken
WEBSITE_URL=UrlWhereWebsiteIsHosted

Version de Développement :

Afin de lancer le projet en mode développement il vous faudra avoir docker ainsi que docker compose sur votre machine. Vous pouvez suivre ces tutoriels afin de les installer:

• Installer Docker
• Installer Docker Compose

Il vous faudra ensuite vous rendre à la racine du repository et lancer la commande suivante :

Avec Logs :

foo@bar:~$ docker-compose -f ./docker-compose-dev.yaml up --build

Sans Logs :

foo@bar:~$ docker-compose -f ./docker-compose-dev.yaml up --build -d

Vous aurez ensuite accès aux fonctionnalités aux adresses suivantes:

• http://localhost → Plateforme Web
• http://localhost:8080 → Server Web
• http://localhost:8081 → Inspecteur de bdd

Version de Production :

Afin de lancer le projet en mode développement il vous faudra avoir docker ainsi que docker compose sur votre machine. Vous pouvez suivre ces tutoriels afin de les installer:

• Installer Docker
• Installer Docker Compose

Il vous faudra ensuite vous rendre à la racine du repository et lancer la commande suivante :

Avec Logs :

foo@bar:~$ docker-compose -f ./docker-compose-prod.yaml up --build

Sans Logs :

foo@bar:~$ docker-compose -f ./docker-compose-prod.yaml up --build -d

Vous aurez ensuite accès aux fonctionnalités aux adresses suivantes:

• http://localhost → Plateforme Web
• http://localhost:8080 → Server Web

Contribution

Si vous souhaitez contribuer, créez votre branche et faites des pull requests sur la branch Dev.

Auteurs

• Alex Gaignard alias @XelaG
• Léo Ménard alias @softhy85
• Matthieu Desrues alias @MinMatth-Magi
• Marc Olivier Lauret alias @Marc-olivierLAURET
• Fabien Cheung Lim Yen alias @Fistoflex
• Dimitri Clain alias @Dimitri-CLAIN
• Paul Van Kerckvoorde alias @Polipoppy
• Timothé Fertin alias @Tim-Snugget

License

Ce projet est sous licence exemple: WTFTPL - voir le fichier LICENSE.md pour plus d'informations