Skip to content

Home

Jump to bottom
Prathap Mathiyalagan edited this page Feb 9, 2022 · 1 revision

Welcome to the ccs-scale-cat-buyer-ui wiki!

CCS Scale CaT Buyer UI

Getting Started

Prerequisites

Running the application requires the following tools to be installed in your environment:

Running the application

Install dependencies by executing the following command:

$ npm install
$ npm configure

Run:

$ npm start

Or for windows PC

$ npm start:win

The applications's home page will be available at http://localhost:3000

Developing

Code style

We use ESLint alongside sass-lint

Running the linting:

$ npm run lint

Running the unit test case:

$ npm run test:routes

Running the tests

This template app uses mocha as the test engine. You can run unit tests by executing the following command:

Running accessibility tests:

$ npm run test:a11y

Make sure all the paths in your application are covered by accessibility tests (see a11y.ts).

Healthcheck

The application exposes a health endpoint (https://localhost:3000/health), created with the use of Nodejs Healthcheck library. This endpoint is defined in health.ts file. Make sure you adjust it correctly in your application. In particular, remember to replace the sample check with checks specific to your frontend app, e.g. the ones verifying the state of each service it depends on.

Provisioning

Local initialisation & provisioning

You need to have values for below environment variables (in hosted env it will come from gov PaaS environment variable). If you are using the MacBook you can have below values in bash_profile, if you are using windows laptop create .env file in the root folder and put below values init.

AUTH_SERVER_CLIENT_ID=<value>
AUTH_SERVER_CLIENT_SECRET=<value>
AUTH_SERVER_BASE_URL=<value>
CAT_URL=http://localhost:3000
TENDERS_SERVICE_API_URL=<value>
LOGIT_API_KEY=<value>
REDIS_HOST=<value>
REDIS_PORT=<value>
SESSION_SECRET=<value>
AGREEMENTS_SERVICE_API_URL=<value>
CONCLAVE_WRAPPER_API_KEY=<value>
CONCLAVE_WRAPPER_API_BASE_URL=<value>
GOOGLE_TAG_MANAGER_ID=<value>
GOOGLE_SITE_TAG_ID=<value>
ROLLBAR_ACCESS_TOKEN=<value>
ROLLBAR_HOST=local

Use below commands to get the env values.

cf login --sso
cf env dev-ccs-scale-cat-buyer-ui

You need to have Redis local instance running in your PC, if no then update REDIS_HOST value with the hosed Redis service.

License

This project is licensed under the MIT License - see the LICENSE file for details

Clone this wiki locally