Commit af160526 authored by Cornee Traas's avatar Cornee Traas
Browse files

Update README

parent 49746b99
Pipeline #2590 passed with stage
in 3 minutes and 28 seconds
# SEP Autumn 2018 Group 2 EIT-Dashboard
# Lab4MOOCs Coursera Analytics Server
[![Build Status](https://travis-ci.com/cornytrace/SEP-Autumn-2018-Group2-Coursera.svg?token=ksRe83PxhypHvSJboCmE&branch=master)](https://travis-ci.com/cornytrace/SEP-Autumn-2018-Group2-Coursera)
......@@ -6,7 +6,7 @@
### Preparation
Install Python 3.6: https://www.python.org
Install Python 3.6
If you use Visual Studio Code, install the Python extension and add the following to your preferences:
......@@ -45,7 +45,7 @@ $ cd eit-dash-backend
```
## Backend
### Setup
``` bash
......@@ -92,6 +92,14 @@ You need to pass the name of an intermediate database to use, which will be used
The test database will remain in the intermediate database after the process is finished, and a coursera.sql file will appear in the root project folder.
The coursera.sql file can be imported into postgres using ``` psql <database_name> -f coursera.sql ```
### Manually refreshing the materialized views
This software uses PostgreSQL Materialized Views in order to cache most of the course data.
This solution trades disk space for increased performance.
One thing to take notice of however, is that materialized views need to be manually refreshed.
It is intended that a user or script, wanting to update the course data in the database, makes the required changes and then calls the refreshviews django management command, either programmatically or via command-line.
This can be done on the command-line using ``` python manage.py refreshviews <exclude> ```, where exclude is an optional space-seperated list of materialized views which must be excluded from the update. By default, no materialized views are excluded.
## Documentation
[Django](https://docs.djangoproject.com/en/2.1/)
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment