mirror of
https://github.com/ae-utbm/sith.git
synced 2025-07-12 12:59:24 +00:00
update documentation
This commit is contained in:
Thomas Girod
@ -7,7 +7,6 @@ Dépendances du système
|
||||
Certaines dépendances sont nécessaires niveau système :
|
||||
|
||||
* poetry
|
||||
* libmysqlclient
|
||||
* libssl
|
||||
* libjpeg
|
||||
* libxapian-dev
|
||||
@ -15,18 +14,80 @@ Certaines dépendances sont nécessaires niveau système :
|
||||
* python
|
||||
* gettext
|
||||
* graphviz
|
||||
* mysql-client (pour migrer de l'ancien site)
|
||||
|
||||
Sur Windows
|
||||
~~~~~~~~~~~
|
||||
|
||||
Chers utilisateurs de Windows, quel que soit votre amour de Windows,
|
||||
de Bill Gates et des bloatwares, je suis désolé
|
||||
de vous annoncer que, certaines dépendances étant uniquement disponibles sur des sytèmes UNIX,
|
||||
il n'est pas possible développer le site sur Windows.
|
||||
|
||||
Heureusement, il existe une alternative qui ne requiert pas de désinstaller votre
|
||||
OS ni de mettre un dual boot sur votre ordinateur : :code:`WSL`.
|
||||
|
||||
- **Prérequis:** vous devez être sur Windows 10 version 2004 ou ultérieure (build 19041 & versions ultérieures) ou Windows 11.
|
||||
- **Plus d'info:** `docs.microsoft.com <https://docs.microsoft.com/fr-fr/windows/wsl/install>`_
|
||||
|
||||
.. sourcecode:: bash
|
||||
|
||||
# dans un shell Windows
|
||||
wsl --install
|
||||
|
||||
# afficher la liste des distribution disponible avec WSL
|
||||
wsl -l -o
|
||||
|
||||
# installer WSL avec une distro (ubuntu conseillé)
|
||||
wsl --install -d <nom_distro>
|
||||
|
||||
.. note::
|
||||
|
||||
Si vous rencontrez le code d'erreur ``0x80370102``, regardez les réponses de ce `post <https://askubuntu.com/questions/1264102/wsl-2-wont-run-ubuntu-error-0x80370102>`_.
|
||||
|
||||
Une fois :code:`WSL` installé, mettez à jour votre distro & installez les dépendances **(voir la partie installation sous Ubuntu)**.
|
||||
|
||||
.. note::
|
||||
|
||||
Comme `git` ne fonctionne pas de la même manière entre Windows & Unix, il est nécessaire de cloner le repository depuis Windows.
|
||||
(cf: `stackoverflow.com <https://stackoverflow.com/questions/62245016/how-to-git-clone-in-wsl>`_)
|
||||
|
||||
Pour accéder au contenu d'un répertoire externe à :code:`WSL`, il suffit simplement d'utiliser la commande suivante:
|
||||
|
||||
.. sourcecode:: bash
|
||||
|
||||
# oui c'est beau, simple et efficace
|
||||
cd /mnt/<la_lettre_du_disque>/vos/fichiers/comme/dhab
|
||||
|
||||
Une fois l'installation des dépendances terminée (juste en dessous), il vous suffira, pour commencer à dev, d'ouvrir votre plus bel IDE et d'avoir 2 consoles:
|
||||
1 console :code:`WSL` pour lancer le projet & 1 console pour utiliser :code:`git`
|
||||
|
||||
.. note::
|
||||
|
||||
A ce stade, si vous avez réussi votre installation de :code:`WSL` ou bien qu'il
|
||||
était déjà installé, vous pouvez effectuer la mise en place du projet en suivant
|
||||
les instructions pour Ubuntu.
|
||||
|
||||
|
||||
Sur Ubuntu
|
||||
~~~~~~~~~~
|
||||
|
||||
.. sourcecode:: bash
|
||||
|
||||
sudo apt install libssl-dev libjpeg-dev zlib1g-dev python-dev libffi-dev python-dev libgraphviz-dev pkg-config libxapian-dev gettext git
|
||||
# Sait-on jamais
|
||||
sudo apt update
|
||||
|
||||
sudo apt install python-is-python3 # Permet d'utiliser python au lieu de python3, c'est optionel
|
||||
|
||||
sudo apt install build-essentials libssl-dev libjpeg-dev zlib1g-dev python-dev \
|
||||
libffi-dev python-dev-is-python3 libgraphviz-dev pkg-config libxapian-dev \
|
||||
gettext git
|
||||
|
||||
curl -sSL https://install.python-poetry.org | python -
|
||||
|
||||
# To include mysql for importing old bdd
|
||||
sudo apt install libmysqlclient-dev
|
||||
.. note::
|
||||
|
||||
Si vous avez réussi à exécuter les instructions ci-dessus sans trop de problèmes,
|
||||
vous pouvez passer à la partie :ref:`Finalise installation`
|
||||
|
||||
Sur MacOS
|
||||
~~~~~~~~~
|
||||
@ -51,61 +112,21 @@ Pour installer les dépendances, il est fortement recommandé d'installer le ges
|
||||
|
||||
Si vous rencontrez des erreurs lors de votre configuration, n'hésitez pas à vérifier l'état de votre installation homebrew avec :code:`brew doctor`
|
||||
|
||||
Sur Windows avec :code:`WSL`
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
.. note::
|
||||
|
||||
Comme certaines dépendances sont uniquement disponible dans un environnement Unix, il est obligatoire de passer par :code:`WSL` pour installer le projet.
|
||||
Si vous avez réussi à exécuter les instructions ci-dessus sans trop de problèmes,
|
||||
vous pouvez passer à la partie :ref:`Finalise installation`
|
||||
|
||||
- **Prérequis:** vous devez exécuter Windows 10 versions 2004 et ultérieures (build 19041 & versions ultérieures) ou Windows 11.
|
||||
- **Plus d'info:** `docs.microsoft.com <https://docs.microsoft.com/fr-fr/windows/wsl/install>`_
|
||||
|
||||
.. sourcecode:: bash
|
||||
.. _Finalise installation:
|
||||
|
||||
# dans un shell Windows
|
||||
wsl --install
|
||||
|
||||
# afficher la liste des distribution disponible avec WSL
|
||||
wsl -l -o
|
||||
|
||||
# installer WSL avec une distro
|
||||
wsl --install -d <nom_distro>
|
||||
|
||||
.. note::
|
||||
|
||||
Si vous rencontrez le code d'erreur ``0x80370102``, regardez les réponses de ce `post <https://askubuntu.com/questions/1264102/wsl-2-wont-run-ubuntu-error-0x80370102>`_.
|
||||
|
||||
Une fois :code:`WSL` installé, mettez à jour votre distro & installez les dépendances **(voir la partie installation sous Ubuntu)**.
|
||||
|
||||
.. note::
|
||||
|
||||
Comme `git` ne fonctionne pas de la même manière entre Windows & Unix, il est nécessaire de cloner le repository depuis Windows.
|
||||
(cf: `stackoverflow.com <https://stackoverflow.com/questions/62245016/how-to-git-clone-in-wsl>`_)
|
||||
|
||||
Pour accéder au contenu d'un répertoire externe à :code:`WSL`, il suffit simplement d'utiliser la commande suivante:
|
||||
Finaliser l'installation
|
||||
------------------------
|
||||
|
||||
.. sourcecode:: bash
|
||||
|
||||
# oui c'est beau, simple et efficace
|
||||
cd /mnt/<la_lettre_du_disque>/vos/fichiers/comme/dhab
|
||||
|
||||
.. note::
|
||||
|
||||
Une fois l'installation des dépendances terminée (juste en dessous), il vous suffira, pour commencer à dev, d'ouvrir votre plus bel IDE et d'avoir 2 consoles:
|
||||
1 console :code:`WSL` pour lancer le projet & 1 console pour utiliser :code:`git`
|
||||
|
||||
Installer le projet
|
||||
-----------------------------------
|
||||
|
||||
.. sourcecode:: bash
|
||||
|
||||
# Sait-on jamais
|
||||
sudo apt update
|
||||
|
||||
# Les commandes git doivent se faire depuis le terminal de Windows si on utilise WSL !
|
||||
git clone https://github.com/ae-utbm/sith3.git
|
||||
cd Sith
|
||||
cd sith3
|
||||
|
||||
# Création de l'environnement et installation des dépendances
|
||||
poetry install
|
||||
@ -113,7 +134,7 @@ Installer le projet
|
||||
# Activation de l'environnement virtuel
|
||||
poetry shell
|
||||
|
||||
# Prépare la base de donnée
|
||||
# Prépare la base de données
|
||||
python manage.py setup
|
||||
|
||||
# Installe les traductions
|
||||
@ -144,15 +165,21 @@ Il faut toujours avoir préalablement activé l'environnement virtuel comme fait
|
||||
|
||||
.. note::
|
||||
|
||||
Le serveur est alors accessible à l'adresse http://localhost:8000.
|
||||
Le serveur est alors accessible à l'adresse http://localhost:8000 ou bien http://127.0.0.1:8000/.
|
||||
|
||||
Générer la documentation
|
||||
------------------------
|
||||
|
||||
La documentation est automatiquement mise en ligne sur readthedocs à chaque envoi de code sur GitLab.
|
||||
La documentation est automatiquement mise en ligne sur readthedocs à chaque envoi de code sur Github.
|
||||
Pour l'utiliser en local ou globalement pour la modifier, il existe une commande du site qui génère la documentation et lance un serveur la rendant accessible à l'adresse http://localhost:8080.
|
||||
Cette commande génère la documentation à chacune de ses modifications, inutile de relancer le serveur à chaque fois.
|
||||
|
||||
.. note::
|
||||
|
||||
Les dépendances pour la documentation sont optionnelles.
|
||||
Avant de commencer à travailler sur la doc, il faut donc les installer
|
||||
avec la commande :code:`poetry install -E docs`
|
||||
|
||||
.. sourcecode:: bash
|
||||
|
||||
python manage.py documentation
|
||||
|
||||
Reference in New Issue
Block a user