From c571de191863e3f0469cd11ff7e70bf7e33db0c2 Mon Sep 17 00:00:00 2001
From: janmax <mail-github@jmx.io>
Date: Wed, 25 Oct 2017 22:52:45 +0200
Subject: [PATCH] Updated README
---
README.rst | 44 ++++++++++++++++++++++++++++++++------------
1 file changed, 32 insertions(+), 12 deletions(-)
diff --git a/README.rst b/README.rst
index 06107767..235c1ba7 100644
--- a/README.rst
+++ b/README.rst
@@ -11,31 +11,52 @@ Installing
To set up a new instance perform the following steps:
#. Create a virtual environment with a Python3.6 interpreter and activate it.
+
+ It works like this::
+
+ virtualenv -p python3.6 env
+ source env/bin/activate
+
+ Just type ``deactivate`` the get out.
+
+#. Set the environment variable ``DJANGO_DEV`` to ``True`` like this::
+
+ export DJANGO_DEV=True
+
#. Install dependencies::
- pip install -r requirements.txt
- yarn install --modules-folder core/static/node_modules
+ pip install -r requirements.txt
+ yarn install --modules-folder core/static/node_modules
+
+ or alternatively with the make task::
- or alternatively with the make task::
+ make install
- make install
+#. Set up a Postgres 9.5 database. If you have docker installed the easiest way is to just run it in a docker container, like this::
-#. Set up the database.
+ docker run --rm --name postgres -p 5432:5432 postgres:9.5
- If you are running a local instance for development purposes you
- may just run::
+ And apply database migrations::
python manage.py migrate
python manage.py loaddata core/fixtures/testdata-groups.json
#. Create a superuser if necessary::
- python manage.py createsuperuser
+ python manage.py createsuperuser
-#. Your instance should now be ready to be filled with real data. If you just
- need some basic examples you can load them with::
+ More users can be added in the admin interface. You should be able to reach it via http://localhost:8000/admin.
+
+#. Everything is set. You can start the development server with::
+
+ python3 manage.py runserver
+
+ or just::
+
+ make run
+
+#. Reliable test data will follow soon (promise).
- make loadexamples
Overview
========
@@ -55,4 +76,3 @@ Grady has three basic functions for the three types of users
+ review their final feedback and score in the post exam review
An overview over the database can be found in the docs folder.
-
--
GitLab