Step 1 : Install Node Version Manager
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.1/install.sh | bash
# or
wget -qO- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.1/install.sh | bash
# or
brew install nvm
Check the version nvm --version
Step 2 : nvm install 18.19.0
Step 3: nvm use 18.19.0
Step 4: npm i -g yarn
Step 5: touch .env then copy and paste the ACRS secrets into this file Step 6: yarn
Step 7: yarn run start:dev
- Node.js - Tested against LTS
- NPM (installed with Node.js) - Works with versions 2 and 3
- Redis server running on the default port
If this is a first-time install get postgres running on the default port and setup a new, empty local database called acrs
.
Run hof-rds-api locally for the acrs service. Hof-rds-api is an api that will read and write to your local database.
Follow the instructions in the hof-rds-api README to setup the correct configuration for your local acrs
database and run the api in relation to acrs.
First make sure you have the hof-rds-api running for the 'acrs' service and a local database setup for it to read and write to. If not follow the steps in the Database setup and integration section above.
Clone this repository to your local machine then:
$ cd acrs
$ touch .env
$ yarn install
$ yarn start:dev
Then visit: http://localhost:8080/ For the start page and applicant journey
You can skip the email authentication locally or in some of the testing environments. You'll need to make sure you have an environment variable allowSkip=true
. You'll also need an email as part of save and return. You have 3 options either: using a skipEmail
environment variable; using a key value paramenter in the url; or both.
-
To use an email environment variable, you'll need to set it like so
[email protected]
. You can then go to the following url. -
Set the email in the url to whatever email you like.
http://localhost:8080/acrs/start?token=skip&[email protected]
-
If you do both, then the app will always use what you've set in the url parameter as the email.
$ yarn run test
will run all tests.
$ yarn run test:lint
$ yarn test:unit