diff --git a/README.rst b/README.rst index 235c1ba706d502666a5a88ce679e239680037ac7..2c74de50de26e39a8ff05b971f428ca835aa2d66 100644 --- a/README.rst +++ b/README.rst @@ -10,52 +10,51 @@ Installing To set up a new instance perform the following steps: -#. Create a virtual environment with a Python3.6 interpreter and activate it. - +#. 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 + 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:: +#. Set the environment variable ``DJANGO_DEV`` to ``True`` like this:: - export DJANGO_DEV=True + export DJANGO_DEV=True -#. Install dependencies:: +#. 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:: - 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 a Postgres 9.5 database. If you have docker installed the easiest way is to just run it in a docker container, like this:: - docker run --rm --name postgres -p 5432:5432 postgres:9.5 + docker run --rm --name postgres -p 5432:5432 postgres:9.5 - And apply database migrations:: + And apply database migrations:: - python manage.py migrate - python manage.py loaddata core/fixtures/testdata-groups.json + python manage.py migrate + python manage.py loaddata core/fixtures/testdata-groups.json -#. Create a superuser if necessary:: +#. Create a superuser if necessary:: - python manage.py createsuperuser + python manage.py createsuperuser - More users can be added in the admin interface. You should be able to reach it via http://localhost:8000/admin. + 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:: +#. Everything is set. You can start the development server with:: - python3 manage.py runserver + python3 manage.py runserver - or just:: + or just:: - make run + make run -#. Reliable test data will follow soon (promise). +#. Reliable test data will follow soon. Overview @@ -64,15 +63,20 @@ Overview Grady has three basic functions for the three types of users - Reviewers can - + edit feedback that has been provided by tutors - + mark feedback as final if it should not be modified (only final feedback is shown to students) - + delete feedback (submission will be reassigned) + + + edit feedback that has been provided by tutors + + mark feedback as final if it should not be modified (only final feedback is shown to students) + + delete feedback (submission will be reassigned) + - Tutors can - + request a submission that they have to correct and submit feedback for - + deleted their own feedback - + review feedback of other tutors - + they do not see which student submitted the solution + + + request a submission that they have to correct and submit feedback for + + deleted their own feedback + + review feedback of other tutors + + they do not see which student submitted the solution + - Students can - + review their final feedback and score in the post exam review + + + review their final feedback and score in the post exam review An overview over the database can be found in the docs folder.