UniRide-SME

API et objets métiers de l'application web UniRide

Prérequis

1. Installez python

2. Clonez le dépôt sur votre machine locale :

$ git clone https://github.com/DUT-Info-Montreuil/UniRide-SME.git

3. Modifier les variables d'environnement disponible dans uniride-backend-template.env qui se trouve à la racine pour le bon fonctionnement du site. Ces variables d'environnement doivent imperativement etre changer :

Configuration API Google Maps

• GOOGLE_API_KEY=AIzdz74yBMre5LC2BJ2f-HFPPhYISSIu0mSSthtrt2Gs

Configuration de l'adresse de l'université

• UNIVERSITY_STREET_NUMBER=140
• UNIVERSITY_STREET_NAME=Rue de la Nouvelle France
• UNIVERSITY_POSTAL_CODE=93100
• UNIVERSITY_CITY=Montreuil
• UNIVERSITY_EMAIL_DOMAIN=iut.univ-paris8.fr
• FRONT_END_URL=https://127.0.0.1:5050/

Serveur mail

• MAIL_USERNAME=uniride.uniride@gmail.com
• MAIL_PASSWORD=XXX
• MAIL_SERVER=smtp.gmail.com
• SECRET_KEY=XXX
• SECURITY_PASSWORD_SALT=XXX

Dossier de documents

• PFP_UPLOAD_FOLDER=chemin\vers\votre\documents\pft
• LICENSE_UPLOAD_FOLDER=chemin\vers\votre\documents\license
• ID_CARD_UPLOAD_FOLDER=chemin\vers\votre\documents\id_card
• SCHOOL_CERTIFICATE_UPLOAD_FOLDER=chemin\vers\votre\documents\school_certificate
• INSURANCE_UPLOAD_FOLDER=chemin\vers\votredocuments\insurance

Configuration token JWT

• JWT_SALT=XXX
• JWT_SECRET_KEY=XXX

Attente redis

• RQ_REDIS_URL=redis://localhost:6379/0

Cache redis

• CACHE_REDIS_HOST=localhost
• CACHE_REDIS_PORT=6379

Base de données

• DB_HOST=ip_DB
• DB_NAME=uniride
• DB_USER=uniride
• DB_PWD=XXX
• DB_PORT=5432

Configuration FLask

• FLASK_DEBUG = true
• FLASK_HOST = 0.0.0.0
• FLASK_PORT = 5050

Certificats

• CERTIFICATE_CRT_FOLDER=chemin\vers\votre\certificat.crt
• CERTIFICATE_KEY_FOLDER=chemin\vers\votre\clé.key

Installer les dépendances

4. Exécutez la commande pip install . à l'intérieur du dossier cloné :

$ pip install .

Lancer le projet

5. Pour lancer le projet il vous faut aller à la racine et en faisant :

$ python uniride_sme/rest_api.py

Déploiement avec docker

Pour lancer entièrement l'application UniRide avec docker, vous pouvez vous référer à ce read me Docker.

License

Sous license GNU GNU GPL3.

Besoin d'aide ?

Pour obtenir davantage d'aide sur Python, utilisez la commande pip --help ou consultez le README d'Angular CLI python.

Pour obtenir davantage d'aide sur Flask, consultez le site Flask.

Auteur

• CHOUCHANE Rayan / Nayren23
• HAMIDI Yassine / TheFanaticV2
• BOUAZIZ Ayoub / Ayoub-Bouaziz
• YANG Steven / G8LD
• FAURE Grégoire / Pawpawzz