Commit f7dfe15d authored by colm's avatar colm

code fences tics

parent 5258313e
Pipeline #451 failed with stages
......@@ -18,16 +18,19 @@ The web processing is managed via the Python web application framework Flask. ht
To run the development version of the project:
* first clone this repository:
<br>´git clone git@gitlab.constantvzw.org:diversions/diversions-2019.collection-incertitudes.git´ (you will need to have an authorized ssh key to clone via ssh.)
<br>If you simply wish to download the files you can clone over https like so ´git clone https://gitlab.constantvzw.org/diversions/diversions-2019.collection-incertitudes.git´
<br>`git clone git@gitlab.constantvzw.org:diversions/diversions-2019.collection-incertitudes.git`
<br>(you will need to have an authorized ssh key to clone via ssh.)
<br>If you simply wish to download the files you can clone over https like so
<br>`git clone https://gitlab.constantvzw.org/diversions/diversions-2019.collection-incertitudes.git`
<br> or simply [download the .zip](https://gitlab.constantvzw.org/diversions/diversions-2019.collection-incertitudes/-/archive/master/diversions-2019.collection-incertitudes-master.zip)
* create a Python virtual environment to satisfy the project requirments:
<br> using a terminal session move into the cloned repository of the step above. In my case: ´cd /home/colm/git/diversions-2019.collection-incertitudes´
<br> create a virtual env by typing this command into the terminal session: ´virtualenv venv´ (if you are on Mac OS follow this guide to make sure you have pip and virtualenv tools http://macosxbits.com/2016/01/how-to-install-setup-virtualenv-on-mac-os-x/)
<br> using a terminal session move into the cloned repository of the step above. In my case:<br>`cd /home/colm/git/diversions-2019.collection-incertitudes`
<br> create a virtual env by typing this command into the terminal session:<br>`virtualenv venv`
<br>(if you are on Mac OS follow this guide to make sure you have pip and virtualenv tools http://macosxbits.com/2016/01/how-to-install-setup-virtualenv-on-mac-os-x/)
<br> this will create a folder called venv containing an isolated python environment (this ensure all contributors to the project work on exactly the same versions of each dependency and aids deployment to web-servers later)
* activate the virtualenv:
<br> at the terminal promp type `source venv/bin/activate` or shorter ´. venv/bin/activate´.
<br> if successful, your terminal prompt will be prefaced with a paranthesis containting the name of your virtual environment. It will look something like this:<br>´(venv) [colm@colm-arch diversions-2019.collection-incertitudes]
<br> at the terminal promp type<br> `source venv/bin/activate` or the shorter `. venv/bin/activate`.
<br> if successful, your terminal prompt will be prefaced with a paranthesis containting the name of your virtual environment. It will look something like this:<br>*(venv) [colm@colm-arch diversions-2019.collection-incertitudes]$*
* install the project dependencies inside the virtualenv:
<br>`pip install -r requirements.txt`
<br>(this reads all the package names in the file requirements.txt and installs them via pip, it will not take very long)
......@@ -35,4 +38,4 @@ To run the development version of the project:
<br>`python __init__.py`
<br>(the terminal will inform you of the starting of the app as well as development information)
* visit the site:
<br>open <http://localhost:5000> in your browser and you should see the web pages rendred
<br>open <http://localhost:5000> in your browser and you should see the web pages rendred
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment