data.gov.uk

data.gov.uk website.

License: MIT

Settings

Moved to settings.

Running locally

The following steps will explain how to run the application locally and get in to a state where pull requests can be opened to modify the project on github. They assume a user using Mac OSX.

Install docker desktop

https://docs.docker.com/desktop/setup/install/mac-install/

Install justfile

just is a simple way to save/run project-specific commands. It's an alternative to make and the devs go in to the differences on the project homepage; https://github.com/casey/just

brew install just

Initialise with justfile

just init

Bring up the project under docker

just up

The project should now be running and accessible at http://localhost:8000/

Basic Commands

Running tests with pytest

just test - runs the tests under docker

View docker stack logs

just logs

Rebuild the docker stack

just build

Other common commands

just should list out other common commands in the project

Sentry

Sentry is an error logging aggregator service. You can sign up for a free account at https://sentry.io/signup/?code=cookiecutter or download and host it yourself. The system is set up with reasonable defaults, including 404 logging and integration with the WSGI application.

You must set the DSN url in production.

Deployment

The following details how to deploy this application.

Heroku

See detailed cookiecutter-django Heroku documentation.

Docker

See detailed cookiecutter-django Docker documentation.

Docs

Developer docs are located in docs/.