Getting started¶

The following we present a short guide on how to get started with OLDP. If you encounter any problems, do not hesitate to write an issue or contact us via email or Twitter.

Install dependencies¶

apt-get install -y $(cat apt-requirements.txt)
pip install -r requirements.txt
npm install

Run tests¶

Automated tests use Django`s testing API. If you are not familiar with Django have a look at their extensive documentation first.

For testing we use settings slightly different to development and production. For instance, SQLite is used as database to speed up testing. To use the testing settings, set the configuration variable as following:

export DJANGO_CONFIGURATION=Test

Next, you can run either all or specific tests:

# all tests
./manage.py test

# tests from the laws app
./manage.py test oldp.apps.laws.tests

# tests only views
./manage.py test --tag=views

Some tests require external services (Elasticsearch or web access). To enable or disable them, set the configuration variables:

export DJANGO_TEST_WITH_ES=1
export DJANGO_TEST_WITH_WEB=0

Docker¶

To get the dependency services (database, search, cache) running we suggest to use Docker Compose. Compose is a tool for defining and running multi-container Docker applications.

See Docker

Run server manually¶

Run webpack to create the website assets:

npm run-script build

Set the right environment:

export DJANGO_CONFIGURATION=Dev

Before running the server for the first time you need to set up the database schema and collect all static files to a single location.

./manage.py migrate
./manage.py collectstatic 

Now you are ready to go:

./manage.py runserver

An admin account can be created using:

./manage.py createsuperuser