Skip to content

uktrade/trade-remedies-public

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

trade-remedies-public-ui

All Contributors codecov

Public-facing UI for the Trade Remedies system

Code Style

Live Services Team use Black for python code formatting and flake8 for code analysis.

Development

Set up

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.

Running the project

This project should be run using the Trade Remedies orchestration project available at: https://github.com/uktrade/trade-remedies-docker

BDD testing

Behavioural testing is provided by Behave Django and can be triggered by running:

make bdd

from the Trade Remedies orchestration project directory.

Fitness Functions

Current fitness metrics for TRSV2

Contributors ✨

Thanks goes to these wonderful people (emoji key):


Harel Malka

💻

Robert Meredith

💻 🎨

Luisella Strona

👀

Mark Higham

💻 📖

Nao Yoshino

💻

Paul Cooney

💻

Michal Charemza

💻 👀

Krishna White

💻

Brendan Quinn

💻

This project follows the all-contributors specification. Contributions of any kind welcome!