Service for authenticating users for services that serve the Exporting is Great campaign for the Department for International Trade (DIT).
For more information on installation please check the Developers Onboarding Checklist
$ git clone https://github.com/uktrade/directory-sso $ cd directory-sso $ make
Running with Docker
Requires all host environment variables to be set.
$ make docker_run
Run debug webserver in Docker
Provides defaults for all environment variables.
$ 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
Running locally without Docker
$ git clone https://github.com/uktrade/directory-sso $ cd directory-sso $ virtualenv .venv -p python3.5 $ source .venv/bin/activate $ pip install -r requirements_text.txt
Running the webserver
$ source .venv/bin/activate $ make debug_webserver
Running the tests
$ make debug_test
Setup debug environment
Requires locally running PostgreSQL (e.g. Postgres.app for the Mac)
$ make debug
Run debug webserver
$ make debug_webserver
Run debug tests
$ make debug_test
For development efficiency a dummy user can be loaded into the database from
fixtures/development.json. To do this run:
The credentials for the development user `firstname.lastname@example.org
fixtures/development.json with the current contents of the database run:
Then check the contents of
If you're doing front-end development work you will need to be able to compile the SASS to CSS. For this you need:
$ npm install $ gulp
We add compiled CSS files to version control. This will sometimes result in conflicts if multiple developers are working on the same SASS files. However, by adding the compiled CSS to version control we avoid having to install node, npm, node-sass, etc to non-development machines.
You should not edit CSS files directly, instead edit their SCSS counterparts.