Skip to content

Commit

Permalink
feat(DTFS2-NONE): update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
AlexBramhill committed Apr 4, 2024
1 parent b696e3a commit 8d0a7a8
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
# Digital Trade Finance Service :briefcase:

This repository contains the code for the UK Export Finance Trade Finance Service.
This documentation provides a comprehensive overview of the UKEF Digital TradeFinance Service (DTFS), including prerequisites, technology stack, setup instructions, testing procedures, deployment guidelines, and other essential information for the developers.

Expand Down Expand Up @@ -89,6 +90,7 @@ npm run stop
## Different docker compose files

There are 3 different docker compose files right now.

- docker-compose.yml is used for local development
- docker-compose.gha.yml is used for the pipelines to run our tests against
- docker-compose.replica-set.yml is used when you need a replica set enabled on your local database, e.g. when working with the mongodb change stream
Expand Down Expand Up @@ -193,8 +195,9 @@ Client side JavaScript files are protected by SRI security feature which allows
This can be done by updating the `integrity` attribute in any HTML/Nunjucks `script` tags that use the file to reflect the new hash of the recompiled file (a good place to check for these `script` tags is the `templates/index.njk` file in the service).

Check notice on line 195 in README.md

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

README.md#L195

Expected: 80; Actual: 252

There are two ways to update these:
- Run `cat FILENAME.js | openssl dgst -sha512 -binary | openssl base64 -A` on each;
- Or render a template that uses the script in a browser; a console error should give you the hash of the recompiled file.

1. (Preferred) Render a template that uses the script in a browser; a console error should give you the hash of the recompiled file.

Check notice on line 199 in README.md

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

README.md#L199

Expected: 80; Actual: 132
2. Run `cat FILENAME.js | openssl dgst -sha512 -binary | openssl base64 -A` on each. Note -- GEF UI references Portal UI's `govukFrontend.js`

Check notice on line 200 in README.md

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

README.md#L200

Expected: 80; Actual: 141

## Linting :mag_right:

Expand Down

0 comments on commit 8d0a7a8

Please sign in to comment.