Prerequisite dependencies used by multiple packages within this repository are documented in Prerequisites
warning: other service dependencies will be missing, install and run from root of the repository to run whole package of applications
| name | description | mandatory |
|---|---|---|
| APPLICATIONINSIGHTS_CONNECTION_STRING | Connection string to log to App Insights in Azure | N |
| AZURE_STORAGE_ACCOUNT | Microsoft Azure or Azurite storage account name | Y |
| AZURE_STORAGE_ACCESS_KEY | Microsoft Azure or Azurite storage account shared access key | Y |
| MAX_GEOSPATIAL_LAND_BOUNDARY_UPLOAD_MB | Maximum size of a geospatial land boundary upload (in megabytes) | Y |
| SESSION_COOKIE_PASSWORD | Password for the session cookie | N |
| UPLOAD_PROCESSING_TIMEOUT_MILLIS | Upload processing timeout in milliseconds (defaults to 30000) | N |
| AZURE_FUNCTION_APP_URL | API URL for funtion app | Y |
| COOKIE_IS_SECURE | Sets isSecure flag for session cookie, set to true if site is SSL or false if not | N |
| MAX_METRIC_UPLOAD_MB | Maximum size of a biodiversity metric file upload (in megabytes) | |
| GOOGLE_TAGMANAGER_ID | Google Tag Manager ID | N |
| NODE_ENV | sets whether environment is development, test or production, assumed production by default if undefined | N |
| SERVICE_HOME_URL | Sets the full url of service home page | N |
| DEFRA_ID_SESSION_COOKIE_PASSWORD | 32 character minimum password for session auth cookie | Y |
| DEFRA_ID_POLICY_ID | Defra ID policy ID | Y |
| DEFRA_ID_SERVICE_ID | Defra ID Service ID | Y |
| DEFRA_ID_INSTANCE | Defra ID instance ID | Y |
| DEFRA_ID_DOMAIN | Defra ID Domain | Y |
| DEFRA_ID_CLIENT_SECRET | Defra ID Client Secret | Y |
| DEFRA_ID_CLIENT_ID | Defra ID Client ID | Y |
| DEFRA_ID_REDIRECT_URI | Defra ID redirect URI | Y |
| DEFRA_ID_ACCOUNT_MANAGEMENT_URL | Defra ID account management URL | Y |
| MAX_GEOSPATIAL_FILE_UPLOAD_MB | MVP recommendation to change file size limit on geospatial files | Y |
| BACS_ACCOUNT_NAME | Natural England Bacs account name | Y |
| BACS_SORT_CODE | Natural England Bacs sort code (with no spaces) | Y |
| BACS_ACCOUNT_NUMBER | Natural England Bacs account number | Y |
| BACS_SWIFT_CODE | Natural England Bacs SWIFT / BIC code | Y |
| DISABLED_ROUTES | Used to enable/disable features and routes in form of string with semicolon | N |
| ENABLE_ROUTE_SUPPORT_FOR_ADDITIONAL_EMAIL | Feature flag for additional email in the developer journey | Y |
| ENABLE_ROUTE_SUPPORT_FOR_ADDITIONAL_EMAIL | Feature flag for additional email in the developer journey | Y |
| ENABLE_ROUTE_SUPPORT_FOR_CREDIT_ESTIMATION_JOURNEY | Feature flag for credits estimation journey | Y |
| ENABLE_ROUTE_SUPPORT_FOR_CREDIT_PURCHASE_JOURNEY | Feature flag for credits purchase journey | Y |
| ENABLE_ROUTE_SUPPORT_FOR_COMBINED_CASE_JOURNEY | Feature flag for combined case journey | Y |
| DEFRA_ID_MOCK | Disables defra ID integration | N |
| LOG_LEVEL | Pino logging level (defaults to warn) | N |
| SERVICE_NAME | Service name as used in the GOV UK header (defaults to 'Manage biodiversity gains') | N |
| BACKEND_API_BASE_URL | URL for API to backend resources, if not set resorts to local mock address | N |
| BACKEND_API_SUBSCRIPTION_KEY | Subscription key to connect to APIM for backend API, if not set resorts to local mock value | N |
| BACKEND_API_CODE_QUERY_PARAMETER | Query code parameter to pass to APIM | N |
| BACKEND_API_MOCK_BGS_FOR_ACCEPTANCE | Mock BGS number for pipeline acceptance tests to bypass API checks, only used if set | N |
If HTTP triggered functions in the azure-functions package are accessed through an API Gateway, the environment variable must reference the API Gateway accordingly.
When connecting to an Azurite container the following additional environment variables must be specified. | name | description | | AZURE_BLOB_SERVICE_URL | URL used to access the Azurite blob service | | AZURE_QUEUE_SERVICE_URL | URL used to access the Azurite queue service |
Install and build the application
npm i
Run the application
npm run local:start
To build and start the container
npm run docker:build
npm run docker:startTo stop and clear the container
npm run docker:stopTests require execution from the root of the mono-repository