46 lines
1.1 KiB
Markdown
46 lines
1.1 KiB
Markdown
# Requirements
|
|
|
|
* Django
|
|
* Django REST Framework
|
|
* Python Social Auth
|
|
|
|
An easy way to install the dependencies is provided by using pip. Always
|
|
consider to use virtualenv, be it for testing or for deployment.
|
|
|
|
mkdir virtualenv
|
|
virtualenv -p python3 ./virtualenv
|
|
source ./virtualenv/bin/activate
|
|
pip3 install -U -r requirements.txt
|
|
|
|
NOTE: When working on the project make sure to source the ./bin/activate file
|
|
to set the environment correctly.
|
|
|
|
# Development/Test Environment
|
|
|
|
For convienience during testing you can use some of the helpers, provided
|
|
either through the Makefile or through shell scripts wrapping common actions with Django.
|
|
If your familier with Django you may also iterface as usual using the
|
|
manage.py script.
|
|
|
|
E.g. to start the server you can simply run:
|
|
|
|
./run-testserver
|
|
|
|
# Deployment
|
|
|
|
The testserver should not be used for production systems. Also instead of using
|
|
sqlite PostgreSQL should be installed as the database backend.
|
|
|
|
## Tests
|
|
|
|
Before you deploy the app, you should run the tests provided to make sure everything
|
|
works as expected. Start the
|
|
|
|
make test
|
|
|
|
OR
|
|
|
|
python manage.py test courses
|
|
python manage.py test rest
|
|
|