pcs-frontend

Getting Started

Prerequisites

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

• Node.js v20.0.0 or later
• yarn
• Docker

Running the application

Install dependencies by executing the following command:

yarn install

Bundle:

yarn webpack

Run:

yarn start

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

Running with Docker

Create docker image:

docker-compose build

Run the application by executing the following command:

docker-compose up

This will start the frontend container exposing the application's port on 3209, and a redis instance on port 6379.

In order to test if the application is up, you can visit http://localhost:3209/ in your browser. You should get a very basic home page (no styles, etc.).

Developing

Code style

We use ESLint alongside sass-lint

Running the linting with auto fix:

yarn lint --fix

Running the tests

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

yarn test

The functional UI tests use Playwright, and the pr suite can be run with the following command:

yarn test:functional

By default, the tests will run against http://localhost:3209/, please update the value on line 7 of src/test/config.ts to change this.

There are also several custom test scripts available:

• yarn test:changed - runs only changed spec files
• test:E2eChrome - runs the full E2E suite in Chrome
• test:E2eFirefox - runs the full E2E suite in Firefox
• test:E2eSafari - runs the full E2E suite in Safari

Running accessibility tests:

yarn test:accessibility

Security

CSRF prevention

Cross-Site Request Forgery prevention has already been set up in this template, at the application level. However, you need to make sure that CSRF token is present in every HTML form that requires it. For that purpose you can use the csrfProtection macro, included in this template app. Your njk file would look like this:

{% from "macros/csrf.njk" import csrfProtection %}
...
<form ...>
  ...
    {{ csrfProtection(csrfToken) }}
  ...
</form>
...

Helmet

This application uses Helmet, which adds various security-related HTTP headers to the responses. Apart from default Helmet functions, following headers are set:

• Referrer-Policy
• Content-Security-Policy

There is a configuration section related with those headers, where you can specify:

• referrerPolicy - value of the Referrer-Policy header

Here's an example setup:

    "security": {
      "referrerPolicy": "origin",
    }

Make sure you have those values set correctly for your application.

Healthcheck

The application exposes a health endpoint (https://localhost:3209/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.

License

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