aqie-front-end

Core delivery platform Node.js Frontend Template. Test for deploy. Updated for SonarQube compliance

• Requirements
  • Node.js
• Local development
  • Setup
  • Development
  • Local JSON API
  • Production
  • Npm scripts
• Docker
  • Development Image
  • Production Image
• Licence
  • About the licence

Requirements

Node.js

Please install Node.js >= v18 and npm >= v9. You will find it easier to use the Node Version Manager nvm

To use the correct version of Node.js for this application, via nvm:

cd aqie-front-end
nvm use

Local development

Setup

Install application dependencies:

npm install

Environment variables (.env)

This project reads environment variables via dotenv. For local development:

1. Copy .env.example to .env and fill in values:

cp .env.example .env

2. At minimum, set OS_NAMES_API_KEY to enable UK location lookups (Ordnance Survey Names API):

OS_NAMES_API_KEY=your_os_names_key_here

3. Optional variables (proxies, NI OAuth for testing NI flows, feature toggles) are documented in .env.example.

You can still export variables in your shell if you prefer; .env is simply a convenience for local runs and tests.

Development

To run the application in development mode run:

npm run dev

If you update .env, restart the dev server to pick up changes.

Local JSON API

Whilst the APIs are being developed this app uses a local JSON mock API. To start this locally run:

npm run mockApi

Production

To mimic the application running in production mode locally run:

npm start

Npm scripts

All available Npm scripts can be seen in package.json To view them in your command line run:

npm run

Docker

Development image

Build:

docker build --target development --no-cache --tag aqie-front-end:development .

Run:

docker run -p 3000:3000 aqie-front-end:development

Production image

Build:

docker build --no-cache --tag aqie-front-end .

Run:

docker run -p 3000:3000 aqie-front-end

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