Live Services Team use Black for python code formatting and flake8 for code analysis.
This project uses prettier - https://prettier.io/ - for javascript and sass code formatting
Firstly, you should copy local.env.example to local.env and add the necessary environment variables for a local development environment. local.env is in .gitignore and should not be committed to the repo.
Populate the following environment variables in the local.env file:
| Variable name | Required | Description |
|---|---|---|
S3_BUCKET_NAME |
Yes | S3 bucket name of bucket used for local dev |
S3_STORAGE_KEY |
Yes | AWS access key ID |
S3_STORAGE_SECRET |
Yes | AWS secret access key |
AWS_REGION |
Yes | Change if different from "eu-west-2" |
ORGANISATION_NAME |
Yes | Name for the organisation |
ORGANISATION_INITIALISM |
Yes | Initials for the organisation |
If you are not sure what to use for one of the values above, ask a colleague or contact the SRE team.
This project should be run using the Trade Remedies orchestration project available at: https://github.com/uktrade/trade-remedies-docker
We use pip-compile from https://github.com/jazzband/pip-tools to manage pip dependencies. This runs from the make file when generating requirements:
Run make all-requirements
This needs to be run from the host machine as it does not run in a container.
In order to run prettier on the front end part of this project, in the orchestration project run:
make frontend-code-style
Behavioural testing is provided by Behave Django and can be triggered by running:
make bdd
from the Trade Remedies orchestration project directory.
You can make test objects available for BDD testing by creating views that create them in the 'api_test' app in the Trade Remedies API project.
For more information on the setup of BDD tests see the readme at https://github.com/uktrade/trade-remedies-docker
Thanks goes to these wonderful people who contributed to the original private repo (emoji key):
 Robert Meredith 💻 🎨 |
 Harel Malka 💻 📖 👀 |
 Paul Cooney 💻 |
 Krishna White 💻 |
 Michal Charemza 💻 👀 |
 Nao Yoshino 💻 |
 ravatapalli 💻 |
 Brendan Quinn 💻 |
This project follows the all-contributors specification. Contributions of any kind welcome!