Skip to content

Latest commit

 

History

History
56 lines (34 loc) · 2.32 KB

README.MD

File metadata and controls

56 lines (34 loc) · 2.32 KB

Water Abstraction UI

Build Status Maintainability Rating Coverage Known Vulnerabilities Licence

External and Internal UI for the GOV.UK Water Abstraction Service

Installation

If on Windows you will need to open powershell with administrator privileges and run this command. This is a prerequisite for bcrypt.

npm install --global --production windows-build-tools

On all platforms run:

npm install --only=dev
gulp clean && gulp copy-static-assets && gulp sass

Environment Variables

The required environment variables for local development can be found in the .env.example file.

Launching

node server-internal and/or node server-external

Security

A valid JWT token is required for requests to the API. This should be appended to the URL in the format /API/1.0/org?token=[insert token here].

Please note that a mechanism for obtaining the JWT token is not yet in place.

License

THIS INFORMATION IS LICENSED UNDER THE CONDITIONS OF THE OPEN GOVERNMENT LICENCE found at:

http://www.nationalarchives.gov.uk/doc/open-government-licence/version/3

The following attribution statement MUST be cited in your products and applications when using this information.

Contains public sector information licensed under the Open Government license v3

About the license

The Open Government Licence (OGL) was developed by the Controller of Her Majesty's Stationery Office (HMSO) to enable information providers in the public sector to license the use and re-use of their information under a common open licence.

It is designed to encourage use and re-use of information freely and flexibly, with only a few conditions.