An open API service indexing awesome lists of open source software.

https://github.com/defra/biodiversity-net-gain-service

Node.js software for the Biodiversity Net Gain (BNG) Service
https://github.com/defra/biodiversity-net-gain-service

Last synced: about 1 year ago
JSON representation

Node.js software for the Biodiversity Net Gain (BNG) Service

Awesome Lists containing this project

README

          

# biodiversity-net-gain-service

## For Natural England

[![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](http://standardjs.com)
[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=DEFRA_biodiversity-net-gain-service&metric=alert_status)](https://sonarcloud.io/dashboard?id=DEFRA_biodiversity-net-gain-service)
[![Lines of Code](https://sonarcloud.io/api/project_badges/measure?project=DEFRA_biodiversity-net-gain-service&metric=ncloc)](https://sonarcloud.io/dashboard?id=DEFRA_biodiversity-net-gain-service)
[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=DEFRA_biodiversity-net-gain-service&metric=coverage)](https://sonarcloud.io/dashboard?id=DEFRA_biodiversity-net-gain-service)
[![Bugs](https://sonarcloud.io/api/project_badges/measure?project=DEFRA_biodiversity-net-gain-service&metric=bugs)](https://sonarcloud.io/dashboard?id=DEFRA_biodiversity-net-gain-service)

[Lerna](https://lerna.js.org/) managed nodejs project for Biodiversity Net Gain service

## Packages

| Package | Description | Runnable |
| ----------- | ----------- | ----------- |
| [azure-functions](packages/azure-functions) | Microsoft Azure functions for the Biodiversity Net Gain service | Y |
| [webapp](packages/webapp) | Client side web application for the Biodiversity Net Gain service | Y |
| [azurite-bootstrap-service](packages/azurite-bootstrap-service) | A service for creating Biodiversity Net Gain Service Azure storage infrastructure within an [Azurite](https://hub.docker.com/_/microsoft-azure-storage-azurite) instance | Y |
| [azure-storge-test-utils](packages/azure-storge-test-utils) | Azure storage related functions for use during **unit testing** | N |
| [connectors-lib](packages/connectors-lib) | A library providing connectivity to various dependencies such as cloud resources | N |
| [errors](packages/errors-lib) | Custom errors used by the Biodiversity Net Gain service | N |
| [utils](packages/utils-lib) | Utilities used by the Biodiversity Net Gain service | N |
| [database-version-control](packages/database-version-control) | [Slonik migrator](https://www.npmjs.com/package/@slonik/migrator) based version controlled database scripting for the Biodiversity Net Gain service. | Y |
| [bng-metric-service](packages/bng-metric-service) | A library to provide Biodiversity metric file extraction related functions | N |

## Getting started

* [Prerequisites](docs/prerequisites.md)
* [Local Development Quickstart Using Visual Studio Code Development Containers](docs/local-development-quickstart.md)
* [Configuring And Running An Uncontainerised Local Development Environment Manually](docs/manual-local-development-environment-configuration.md)
* [Containerisation](docs/containerisation.md)

Please consult package specific documentation.

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

[http://www.nationalarchives.gov.uk/doc/open-government-licence/version/3](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

### Additional licencing information

Refer to [NOTICE](./NOTICE)