Rewrite the development documentation.

This commit is contained in:
Peter van der Does
2016-09-02 15:09:09 -04:00
parent 7e9a10d3dc
commit 8607d464f7

View File

@@ -3,23 +3,60 @@
Development
===========
First, create a virtual environment::
Requirements
------------
Get the code
~~~~~~~~~~~~
The code is available on Github::
$ git clone https://github.com/wger-project/wger.git
Create a virtual environment
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
It's a best practise to create a Python virtual environment::
$ virtualenv --python python3 venv-wger
$ source venv-wger/bin/activate
Get the code and start the application. This will create a SQlite database
and populate it with data on the first run::
$ git clone https://github.com/wger-project/wger.git
$ cd wger
Install Requirements
~~~~~~~~~~~~~~~~~~~~
To install the Python requirements::
$ pip install -r requirements_devel.txt
Install NodeJS and npm::
Follow the instructions on the `NPM website <https://docs.npmjs
.com/getting-started/installing-node>`_ and make sure to use Node LTS (4
.x).
Install the npm modules::
$ npm install
Install site
~~~~~~~~~~~~
To install the server::
$ invoke create_settings \
--settings-path /home/wger/wger/settings.py \
--database-path /home/wger/wger/database.sqlite
$ invoke bootstrap_wger \
--settings-path /home/wger/wger/settings.py \
--no-start-server
Start the server
----------------
To start the server::
$ python manage.py runserver
That's it. You can log in with the default administator user: