From 2c2a2a645860c5beeac60452fffa2d2bce5f52f7 Mon Sep 17 00:00:00 2001 From: Fratibus Date: Sat, 24 Aug 2024 13:12:47 +0200 Subject: [PATCH] [doc] ajout commandes dans README --- README.md | 38 ++++++++++++++++++++++++++++- requirement.txt => requirements.txt | 0 2 files changed, 37 insertions(+), 1 deletion(-) rename requirement.txt => requirements.txt (100%) diff --git a/README.md b/README.md index c19d0b6..3a44759 100644 --- a/README.md +++ b/README.md @@ -2,4 +2,40 @@ Site web de l'association -Le script export.py genere un dossier build statique à déployer sur un serveur web. \ No newline at end of file +Le script export.py génère un dossier build statique à déployer sur un serveur web. + +## Tester en local + +Créer un environnement python virtuel : +`python -m venv. venv` + +Activer l'environnement virtuel : +`source .venv/bin/activate` + +Check qu'on utilise bien l'environnement virtuel : +`which python` + +Installer les dépendances : +`pip install -r requirements.txt` + +Générer le site HTML via le script python : +`python export.py` + +Autres arguments : +``` +python export.py --help +usage: export.py [-h] [-o OUTPUT] [-f {gzip,folder,dev}] [-q] + +Build website + +options: + -h, --help show this help message and exit + -o OUTPUT, --output OUTPUT + Output folder or file + -f {gzip,folder,dev}, --format {gzip,folder,dev} + Format output (either gzip, dev or folder) + -q, --quiet +``` + +Déployer le serveur web en local : +`python -m http.server -d build` diff --git a/requirement.txt b/requirements.txt similarity index 100% rename from requirement.txt rename to requirements.txt -- 2.39.5