All cli scripts are listed in the scripts section of package.json;

Install dependencies

$ npm i

All dependencies are listed in the dependencies section of package.json

Run build in production mode

$ npm run build

This script is going to compile a bundle and put in into build folder in the project's root. This folder contains all you need to deploy the application.

Run locally in development mode

$ npm run start

Run unit tests

$ npm run test

Run unit tests in watch mode

$ npm run test:w

Generate code coverage

$ npm run test:cov

Generated coverage report is going to appear as a coverage folder in the project's root.

You can specify api url by setting an API_URL env variable containing the full address. Example: https://api.identifo.com/admin

Api calls are described in services src/services. Each service has it's mocked version. In order to make use of mocked services instead of actual ones you should set a MOCK_API=true environment variable either through cli or using .env file in the project's root.

To configure the SPA to work correctly on subdirectory you need to set BASE_URL environment variable. E.g. if you are deploying to localhost:8000/admin set BASE_URL=admin in the .env file.

If your assets are not served from the root you need to set ASSETS_PATH=/admin/ variable to be the root path to fetch the assets from. Note that in case of ASSETS_PATH the value should be surrounded by slashes as it takes part in different sorts of concatenations.

Go to deploy branch

$ git checkout deploy

This branch is already configured for deployment.

Merge in the develop branch (or another branch you want to see deployed)

$ git merge develop

Then run deploy script. Make sure you've installed all dependencies.

$ npm run deploy

Note: usually it takes up to 5 minutes for the changes to get fully deployed even though it says published in the terminal.