Frontend to the 'Move animals under disease control restriction' service.
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 apha-apps-perms-move-animal-ui
nvm use
We use Catbox for server-side caching. By default the service will use CatboxRedis when deployed and CatboxMemory for
local development.
You can override the default behaviour by setting the SESSION_CACHE_ENGINE
environment variable to either redis
or
memory
.
Please note: CatboxMemory (memory
) is not suitable for production use! The cache will not be shared between each
instance of the service and it will not persist between restarts.
Redis is an in-memory key-value store. Every instance of a service has access to the same Redis key-value store similar
to how services might have a database (or MongoDB). All frontend services are given access to a namespaced prefixed that
matches the service name. e.g. my-service
will have access to everything in Redis that is prefixed with my-service
.
If your service does not require a session cache to be shared between instances or if you don't require Redis, you can
disable setting SESSION_CACHE_ENGINE=false
or changing the default value in ~/src/config/index.js
.
Install application dependencies:
npm install
To run the application in development
mode run:
npm run dev
To mimic the application running in production
mode locally run:
npm start
All available Npm scripts can be seen in package.json To view them in your command line run:
npm run
To update dependencies use npm-check-updates:
The following script is a good start. Check out all the options on the npm-check-updates
ncu --interactive --format group
If you are having issues with formatting of line breaks on Windows update your global git config by running:
git config --global core.autocrlf false
Build:
docker build --target development --no-cache --tag apha-apps-perms-move-animal-ui:development .
Run:
docker run -p 3000:3000 apha-apps-perms-move-animal-ui:development
Build:
docker build --no-cache --tag apha-apps-perms-move-animal-ui .
Run:
docker run -p 3000:3000 apha-apps-perms-move-animal-ui
A local environment with:
- Localstack for AWS services (S3, SQS)
- Redis
- MongoDB
- This service.
- A commented out backend example.
docker compose up --build -d
We have added an example dependabot configuration file to the repository. You can enable it by renaming
the .github/example.dependabot.yml to .github/dependabot.yml
Instructions for setting up SonarCloud can be found in sonar-project.properties
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
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.