Rod Licensing Digital Services

Mono-repo for the rod licensing digital services.

Prerequisites

• Node v14.13+
• Docker v18.06.0+

Cloning

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

git clone ssh://git@ssh.github.com:443/DEFRA/rod-licensing

Using Lerna

This project uses Lerna 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

  Shared business rules for the rod licensing services

• connectors-lib

  Shared infrastructure connectors for the rod licensing services

• dynamics-lib

  Framework to consume the Dynamics ODATA Web API

• gafl-webapp-service

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

• sales-api-service

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

• sqs-receiver-service

  AWS SQS receiver service handles orchestration of SQS queues

• payment-mop-up-job

  Handles reconciliation of incomplete sales

• pocl-job

  Handles processing of post-office counter sales

• fulfilment-job

  Handles processing of licence fulfilment requirements

docker/

• infrastructure.yml

  Local development infrastructure docker compose file

• services.build.yml

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

• services.dev.yml

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

• services.yml

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

Contributing to this project

Please read our contribution guidelines

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.