https://github.com/defra/water-abstraction-ui

GOV.UK front end service built using Node.js for the Water Abstraction service
https://github.com/defra/water-abstraction-ui

Last synced: 6 days ago
JSON representation

GOV.UK front end service built using Node.js for the Water Abstraction service

• Host: GitHub
• URL: https://github.com/defra/water-abstraction-ui
• Owner: DEFRA
• License: other
• Created: 2017-07-27T15:21:28.000Z (over 7 years ago)
• Default Branch: main
• Last Pushed: 2024-04-12T11:27:33.000Z (7 months ago)
• Last Synced: 2024-04-14T07:53:30.945Z (7 months ago)
• Language: JavaScript
• Homepage:
• Size: 30.5 MB
• Stars: 4
• Watchers: 10
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.MD
  • Changelog: CHANGELOG.md

Awesome Lists containing this project

README

        
# Water Abstraction UI

![Build Status](https://github.com/DEFRA/water-abstraction-ui/workflows/CI/badge.svg?branch=main)

[![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=DEFRA_water-abstraction-ui&metric=sqale_rating)](https://sonarcloud.io/dashboard?id=DEFRA_water-abstraction-ui)

[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=DEFRA_water-abstraction-ui&metric=coverage)](https://sonarcloud.io/dashboard?id=DEFRA_water-abstraction-ui)

[![Known Vulnerabilities](https://snyk.io/test/github/DEFRA/water-abstraction-ui/badge.svg)](https://snyk.io/test/github/DEFRA/water-abstraction-ui)

[![Licence](https://img.shields.io/badge/Licence-OGLv3-blue.svg)](http://www.nationalarchives.gov.uk/doc/open-government-licence/version/3)

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.

```bash

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

```

On all platforms run:

```bash

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](./.env.example).

## 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:

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.