diff options
author | Bernhard Posselt <dev@bernhard-posselt.com> | 2016-06-06 00:01:44 +0300 |
---|---|---|
committer | Bernhard Posselt <dev@bernhard-posselt.com> | 2016-06-06 00:01:44 +0300 |
commit | 3facdda8769f12291750bf3f010714dddfd5dafc (patch) | |
tree | 74f76779c63430e28d85734be31eb00cafc4be6b /README.md | |
parent | 3a5e264e0c400af16c3a94ee4dd724e6afe4e432 (diff) |
Add description for dev setup
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 22 |
1 files changed, 22 insertions, 0 deletions
@@ -6,6 +6,28 @@ * Python >= 3.4 +## Development Installation +If you want to get a quick running development setup, you can use a predefined make command to automatically set up a virtual environment and install the web app with sqlite as database. **Do not set up production using this command!** + +First make sure that you've got pyvenv installed. You can check for this by running: + + python3 -m venv -h + +If you got a **No module named venv** error, you need to install it first. Some distributions like Ubuntu require you to install it separately, e.g.: + + sudo apt-get install python3-venv + +Then run: + + make dev-setup + +This will automatically set up an admin user with name **admin** and password **admin**. + +The server can be started by activating the virtual environment first: + + source venv/bin/activate + python manage.py runserver + ## Installation To get started, change into your destination folder and clone the repository: |