Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/defra/rod-licensing

Rod licensing digital services
https://github.com/defra/rod-licensing

fishing govuk licence rod

Last synced: 6 days ago
JSON representation

Rod licensing digital services

Host: GitHub
URL: https://github.com/defra/rod-licensing
Owner: DEFRA
License: other
Created: 2020-02-25T10:49:40.000Z (over 4 years ago)
Default Branch: develop
Last Pushed: 2024-10-29T08:06:56.000Z (21 days ago)
Last Synced: 2024-10-29T09:24:28.359Z (21 days ago)
Topics: fishing, govuk, licence, rod
Language: JavaScript
Homepage:
Size: 36.6 MB
Stars: 8
Watchers: 8
Forks: 3
Open Issues: 70
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE

Awesome Lists containing this project

README

        [![Build Status](https://github.com/defra/rod-licensing/workflows/build.yml/badge.svg)](https://github.com/defra/rod-licensing/actions)

[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=DEFRA_rod-licensing&metric=alert_status)](https://sonarcloud.io/dashboard?id=DEFRA_rod-licensing)

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

[![Reliability Rating](https://sonarcloud.io/api/project_badges/measure?project=DEFRA_rod-licensing&metric=reliability_rating)](https://sonarcloud.io/dashboard?id=DEFRA_rod-licensing)

[![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=DEFRA_rod-licensing&metric=security_rating)](https://sonarcloud.io/dashboard?id=DEFRA_rod-licensing)

[![Lines of Code](https://sonarcloud.io/api/project_badges/measure?project=DEFRA_rod-licensing&metric=ncloc)](https://sonarcloud.io/dashboard?id=DEFRA_rod-licensing)

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

[![Bugs](https://sonarcloud.io/api/project_badges/measure?project=DEFRA_rod-licensing&metric=bugs)](https://sonarcloud.io/dashboard?id=DEFRA_rod-licensing)

[![Code Smells](https://sonarcloud.io/api/project_badges/measure?project=DEFRA_rod-licensing&metric=code_smells)](https://sonarcloud.io/dashboard?id=DEFRA_rod-licensing)

[![Technical Debt](https://sonarcloud.io/api/project_badges/measure?project=DEFRA_rod-licensing&metric=sqale_index)](https://sonarcloud.io/dashboard?id=DEFRA_rod-licensing)

[![Vulnerabilities](https://sonarcloud.io/api/project_badges/measure?project=DEFRA_rod-licensing&metric=vulnerabilities)](https://sonarcloud.io/dashboard?id=DEFRA_rod-licensing)

[![Lerna](https://img.shields.io/badge/maintained%20with-lerna-cc00ff.svg)](https://lerna.js.org/)

[![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)

[![Jest](https://img.shields.io/badge/tested_with-jest-99424f.svg)](https://github.com/facebook/jest)

[![GitHub issues](https://img.shields.io/github/issues/DEFRA/rod-licensing.svg)](https://github.com/DEFRA/rod-licensing/issues/)

[![Code size](https://img.shields.io/github/languages/code-size/DEFRA/rod-licensing.svg)]()

[![Repo size](https://img.shields.io/github/repo-size/DEFRA/rod-licensing.svg)]()

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

# Rod Licensing Digital Services

Mono-repo for the rod licensing digital services.

## Prerequisites

- Node v18.x

- Docker v18.06.0+

## Cloning

Cloning via SSH from behind a firewall which blocks port 22:

```

git clone ssh://[email protected]:443/DEFRA/rod-licensing

```

## Using Lerna

This project uses [Lerna](https://lerna.js.org/) to simplify the management and versioning of multiple packages which comprise the rod licensing digital

service.

Running `npm install` in the root project will automatically run the `lerna bootstrap` command. The result is that any local packages which depend on

one another will be linked locally (using symbolic links).

Running `npm run lerna:clean` will remove all local node_modules.

Running `lernaupdate` will enter an interactive wizard to allow updates of each packages dependencies.

Running `lernaupdate --non-interactive --dependency "aws-sdk@latest"` will update the aws-sdk dependency in all packages which use it.

## Package structure

packages/

- [business-rules-lib](packages/business-rules-lib/README.md)

  > Shared business rules for the rod licensing services

- [connectors-lib](packages/connectors-lib/README.md)

  > Shared infrastructure connectors for the rod licensing services

- [dynamics-lib](packages/dynamics-lib/README.md)

  > Framework to consume the Dynamics ODATA Web API

- [gafl-webapp-service](packages/gafl-webapp-service/README.md)

  > "Get a Fishing Licence" front-end web-application

- [sales-api-service](packages/sales-api-service/README.md)

  > Sales API to support all sales channels and encapsulate integration with Dynamics

- [sqs-receiver-service](packages/sqs-receiver-service/README.md)

  > AWS SQS receiver service handles orchestration of SQS queues

- [payment-mop-up-job](packages/payment-mop-up-job/README.md)

  > Handles reconciliation of incomplete sales

- [pocl-job](packages/pocl-job/README.md)

  > Handles processing of post-office counter sales

- [fulfilment-job](packages/fulfilment-job/README.md)

  > Handles processing of licence fulfilment requirements

- [recurring-payments-job](packages/recurring-payments-job/README.md)

  > Handles processing of recurring payments

docker/

- [infrastructure.yml](docker/README.md#Infrastructure)

  > Local development infrastructure docker compose file

- [services.build.yml](docker/README.md#Services)

  > This contains the necessary definitions to allow docker images to be built both in development and production mode

- [services.dev.yml](docker/README.md#Services)

  > This contains the necessary definitions to allow the services to be run in development mode.

- [services.yml](docker/README.md#Services)

  > This contains the necessary definitions to allow the services to be run in production mode.

## Contributing to this project

Please read our [contribution guidelines](CONTRIBUTING.md)

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