minientreprise-scv / app

Le dépôt principal de La Plante Qr contenant les fichiers de l'application

La Plante Qr 🌷📲

Une plante et un qr code pour apprendre à jardiner !

Le projet 📢

La Plante Qr est une minientreprise (entreprise à but éducatif) créée par les élèves du Sacré Cœur de Vercel. Dans une démarche de développement durable les élèves ont le projet de recycler des bouteilles en verres, pour en faire des pots de fleurs.

Ils ajoutent aux pots tout le nécessaire pour faire pousser une plante (graines, terreau) ainsi qu'un qr code, qui une fois scanné guidera l'utilisateur pas à pas à faire pousser sa plante !

Crédits / licences 💳

Elements externes à "La Plante Qr"

• Liivic: Police d'écriture (licence OFL)
• Python
• Flask
• Fontawesome
• Qr scanner par Nimiq

Elements créés par "La Plante Qr"

• Code source: licence Cecill v2.1 droits à Brice, Armand et au Collège du Sacré Cœur Vercel.
• Éléments graphiques relatifs à "La Plante Qr": licence CC BY-NC-ND 3.0 FR par Armand

Documentation 📘

Pour certaines installations de python, il n'est pas nécessaire d'insérer le 3 après python (ex: python -m pip...)

Dépendances / configuration ⚙️

• Python doit être installé
• Les librairies Pypi du requirements.txt aussi

python3 -m pip install -r requirements.txt 

• Les informations d'une base MongoDB dans config.ini sont requises ainsi que des phrases de passe pour les administrateurs (séparées de virgules).

[mongodb.net]
mongo_server=192.168.1.85:27000/?retryWrites=true&w=majority
mongo_user=user 
mongo_password=password
mongo_scheme=mongodb://

[administration]
passphrases=superpassphraseforadministrat%%r1,anothoeradministartor's p4ssphr4se

Pour vérifier si l'application peut démarrer, il faut exécuter le script _unit_tests.py. Il indiquera si la configuration actuelle permet de démarrer le service.

Tout est prêt, l'application peut démarrer

Lancement de l'application - Mode développement 🚧

Pour démarrer le serveur web, il faut simplement exécuter le fichier main.py (à la racine du projet).

python3 main.py

Lancement de l'application - Mode production 🚦

Le mode production exécute l'application compilée avec un serveur uvicorn.

1. Compiler l'application:

Linux 🐧

sh bin/build.sh

Windows 🪟

.\bin\build.bat

2. Lancer le programme compilé

Linux 🐧

python3 serve.pyc

Windows 🪟

python serve.pyc

Docker 🐳

L'application peut être lancée via docker.

docker-compose up [-d]

-d lancera l'application en detach (en arrière-plan)