pEPR Backend

Backend APIs for: Packaging Extended Producer Responsibilities

• pEPR Backend
  • API endpoints
  • Docker
    • Running with Docker Compose
  • Contributing
  • Architecture
  • Runbooks
  • Known issues
  • Workarounds
  • Licence
    • About the licence

API endpoints

Endpoint	Description
GET: /health	Health
POST: /v1/apply/organisation	Organisation data submission
POST: /v1/apply/registration	Registration data submission
POST: /v1/apply/accreditation	Accreditation data submission

The application runs at https://epr-backend.{env}.cdp-int.defra.cloud, where {env} is one of dev|test|prod

Docker

Running with Docker Compose

The project uses a shared compose file (compose.shared.yml) for all supporting services, which can be used by both backend and frontend repositories.

Run supporting services only:

docker compose -f compose.shared.yml up

Then run the backend locally with npm run dev in a separate terminal.

Run backend + supporting services:

docker compose up

Run backend + frontend + supporting services:

docker compose --profile all up

Run with specific frontend version:

FRONTEND_VERSION=1.2.3 docker compose --profile all up

Include Defra ID stub (for frontend authentication):

docker compose --profile stub up

Supporting services included:

• LocalStack (AWS service emulation)
• MongoDB (backend only)
• Redis (frontend + supporting services)
• nginx-proxy (frontend only)
• cdp-uploader (file upload service)
• cdp-defra-id-stub (authentication stub, --profile stub)

Note: Running the backend requires GOVUK_NOTIFY_API_KEY environment variable.

Contributing

If you intend to contribute to this repository and/or run the application locally, please see the contributing guidance.

Architecture

You can find more information about the project's architecture here, also see the Architecture Decision Records.

Runbooks

You can find this service's runbooks here.

Known issues

None

Workarounds

None

Licence

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 licence v3

About the licence

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.