Complete installation procedures

hitier
1 parent bc7964c5
Showing 1 changed file with 77 additions and 29 deletions Show diff stats
INSTALL.md
-# install
+# Installation de Plan De Charge
  
-## make working dir: 
+## Prérequis
  
-    mkdir /path/to/working-directory
-    git --work-tree=/path/to/working-directory --git-dir=/path/to/the/repo.git checkout -f master
+- python3
  
-## set environment
+## Obtenir un répertoire fonctionnel
+
+    git clone https://gitlab.irap.omp.eu/PDC-IRAP/pdc-web.git
+    cd pdc-web
+
+### Installer l'environment python
  
     python3 -m venv venv
     source venv/bin/activate
     pip install -r requirements.txt
+
+### Configurer l'application
+
     cp resources/pdc_config.py .
     $(EDITOR) pdc_config.py
  
+    cp resources/flaskenv .flaskenv
+
+
+### Jouer les tests et exécuter un serveur local
+
+    pip install -r requirements-tests.txt
+	PYTHONPATH=. pytest
+
+    # éventuellement voir le taux de couverture
+    PYTHONPATH=. pytest  --cov=app --cov-report=xml:"coverage.xml" --cov-report=term --junitxml "tests-report.xml" 
+
+    # ouvrir un serveur sur localhost:5000
+    flask run
+
+## Configurer apache 
+
+Les fichiers concernés:
+
+- pdc_web.wsgi
+- pdc_config.py
+
+La procédure:
+
+    mkdir /var/www/html/pdc-web
+
+    cp ./resources/apache2-virtual-host.conf /etc/apache2/sites-available/pdc-web.conf
+    $(EDITOR) /etc/apache2/sites-available/pdc-web.conf # éditer les paramètres
+    a2ensite pdc-web 
+    apachectl restart
+
+
+### Mise à jour 
+
 ## git autodeploy
  
+Les fichiers concernés:
+
+- scripts/post-deploy.sh
+- resources/post-receive.git-hook
+
+La procédure:
+
+    git --work-tree=/var/www/html/pdc-web --git-dir=/path/to/the/repo.git checkout -f master
+
     # make bare repo
     git clone --bare /path/to/the/repo.git
     # put on hook
@@ -23,31 +72,30 @@
  
     git push to repo
  
-## configure apache 
  
-    cp ./resources/apache2-virtual-host.conf /etc/apache2/sites-available/pdc-web.conf
-    $(EDITOR) /etc/apache2/sites-available/pdc-web.conf # set parameters
-    $(EDITOR) /etc/hosts # to add your hostname if local install
-    apachectl restart
  
-## To Include in install procedures
+Pycharm Integration
+-------------------
  
-- virtual-apage.conf
-- pdc_web.py
-- pdc_web.wsgi
-- .flaskenv
-- post-deploy.sh
-- git-hook
-- git bare repo
-- make venv && source activate && pip -r requi..
-- picharm requirement
-- run with pycharm
-- run with apache+wsgi
-- run with nginx+uwsgi
-- run through docker
-- install standalone on your own server
-- update your server installation
-- ress/flaskenv > .flaskenv
-- run tests
-- PYTHONPATH=. pytest  --cov=app --cov-report=xml:"coverage.xml" --cov-report=term --junitxml "tests-report.xml" 
+As this projects makes use of the application factory
+pattern, using pycharm requires some tiny configuration
+effort.
+
+Look at
+https://flask.palletsprojects.com/en/1.1.x/cli/#pycharm-integration
+for more details.
+
+But basically, you just have to Edit the Run Configurations,
+and set the fields:
+
+- select module name, and set it to 'flask'
+- set  Parameters to run
+
+
+It should read the environment variables
+- FLASK_ENV
+- FLASK_APP
+
+you have previously set in the file `.flaskenv`
  
+Thats it, run you webapp through PyCharm, enjoy.