Skip to content

armgit / wger

Public Imported from GitHub
0

Self hosted FLOSS fitness/workout, nutrition and weight tracker

Rewrite the development documentation.

Peter van der Does8607d464f7f7
diff --git a/docs/development.rst b/docs/development.rst
index 43da33f14..cf5ace359 100644
--- a/docs/development.rst
+++ b/docs/development.rst
@@ -3,23 +3,60 @@
Development
===========
-First, create a virtual environment::
+Requirements
+------------
- $ virtualenv --python python3 venv-wger
- $ source venv-wger/bin/activate
+Get the code
+~~~~~~~~~~~~
-Get the code and start the application. This will create a SQlite database
-and populate it with data on the first run::
+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
$ 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: