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

Data returns service for water abstraction licences
https://github.com/defra/water-abstraction-returns

Last synced: 6 days ago
JSON representation

Data returns service for water abstraction licences

• Host: GitHub
• URL: https://github.com/defra/water-abstraction-returns
• Owner: DEFRA
• License: other
• Created: 2018-07-04T13:40:24.000Z (over 6 years ago)
• Default Branch: main
• Last Pushed: 2024-10-25T14:26:53.000Z (25 days ago)
• Last Synced: 2024-10-25T18:19:58.109Z (24 days ago)
• Language: JavaScript
• Homepage:
• Size: 2.02 MB
• Stars: 1
• Watchers: 9
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.MD
  • Changelog: CHANGELOG.md

Awesome Lists containing this project

README

        
# Water Abstraction Returns

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

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

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

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

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

The water-abstraction-returns service is a evolving solution to initially handle the returns required by water abstraction licences.

The service is developed in HAPI/NodeJS and backed by a Postgres SQL database.  All data is transferred via a REST API with JWT authentication.

## Development Team

This module was developed by the Water Resource Licensing Service team as part of a digital transformation project at [DEFRA](https://www.gov.uk/government/organisations/department-for-environment-food-rural-affairs), a department of the UK government

To find out more about planned reforms to the abstraction licensing service, see the policy paper: [Water abstraction plan: Abstraction licensing service](https://www.gov.uk/government/publications/water-abstraction-plan-2017/water-abstraction-plan-abstraction-licensing-service)

## Environment Variables

The required environment variables for local development can be found in the [.env.example file](./.env.example).

## Contributing to this project

If you have an idea you'd like to contribute please log an issue.

All contributions should be submitted via a pull request.

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