This API provides an interface for calculating charges, queuing transactions and generating transaction files used to produce invoices.
Make sure you already have:
This is one of a number of apps that make up the Water Resource Licencing service. Because of the service's complex infrastructure there is a separate project available that will build a fully working WRLS environment, using Docker. We recommend reaching out to the Water Abstraction team and requesting access to wal-dev-environment if you need to get this project up and running.
This is automatically setup when running locally using wal-dev-environment
Any configuration is expected to be driven by environment variables when the service is run in production as per 12 factor app.
However when running locally in development mode or in test it makes use of the Dotenv package. This is a shim that will load values stored in a .env file into the environment which the service will then pick up as though they were there all along.
Check out .env.example for details of the required things you'll need in your .env file.
Refer to the config files for details of all the configuration used.
If you have an idea you'd like to contribute please log an issue.
All contributions should be submitted via a pull request.
The code style is dictated by Prettier, and we follow StandardJS code rules as implemented by neostandard. This is all managed through ESLint so should play nice with all IDE's.
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
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.