Public | Automated Build

Last pushed: a day ago
Short Description
Export Directory
Full Description

directory-api




Export Directory API service


Requirements

Docker >= 1.10
Docker Compose >= 1.8

Local installation

$ git clone https://github.com/uktrade/directory-api
$ cd directory-api
$ make

Running with Docker

Requires all host environment variables to be set.

$ make docker_run

Run debug webserver in Docker

Provides defaults for all env vars but AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY

$ make docker_debug

Run tests in Docker

$ make docker_test

Host environment variables for docker-compose

.env files will be automatically created (with env_writer.py based on env.json and env-postgres.json) by make docker_test, based on host environment variables with DIRECTORY_API_ prefix.

Debugging

Setup debug environment

Requires locally running PostgreSQL (e.g. Postgres.app for the Mac)

$ make debug

Run debug webserver

$ make debug_webserver

Run debug celery beat scheduler

Requires Redis (e.g. Install and config Redis on Mac OS X via Homebrew for the Mac)

$ make debug_celery_beat_scheduler

Run debug tests

$ make debug_test

Development data

For development efficiency a dummy company can be loaded into the database from fixtures/development.json. To do this run:

make loaddata

To update fixtures/development.json with the current contents of the database run:

make dumpdata

Then check the contents of fixtures/development.json.

Docker Pull Command
Owner
ukti
Source Repository

Comments (0)