cmc-citizen-frontend

KO | EN

gitlite — search

#python #hacktoberfest #react #typescript #linux #docker #macos #nodejs #windows #awesome-list #security #mcp #ios #open-source

cmc-citizen-frontend

(★ 14)

Citizen frontend application for Civil Money Claims

cmc-citizen-frontend Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# CMC Frontend

[![Greenkeeper badge](https://badges.greenkeeper.io/hmcts/cmc-citizen-frontend.svg)](https://greenkeeper.io/)

[![Standard - JavaScript Style Guide](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](http://standardjs.com/)

[![codecov](https://codecov.io/gh/hmcts/cmc-citizen-frontend/branch/master/graph/badge.svg)](https://codecov.io/gh/hmcts/cmc-citizen-frontend)

This is the frontend application for CMC. Service provides web UI for citizens, presented as sequence of HTML 5 web pages designed to GDS Service Design guidelines, so that they can make money claims and / or perform associated actions e.g submitting defence or requesting default judgement.

Service delegates most of the non UI responsibilities to underlying services e.g. claim-store or pdf-service..

### Getting Started

### Prerequisites

* [Node.js](https://nodejs.org/) >= 24 (LTS)
* [yarn](https://yarnpkg.com/)
* [Gulp](http://gulpjs.com/)
* [Docker](https://www.docker.com)

#### Running the application

Install dependencies by executing the following command:

```bash
$ yarn install
 ```

Run:

```bash
$ gulp
```

It will be available at https://localhost:3000

### Running the application on docker (integrated environment)

See the README.md in hmcts/cmc-integration-tests

## Developing

### Code style

We use [TSLint](https://palantir.github.io/tslint/) with [StandardJS](http://standardjs.com/index.html) rules alongside [sass-lint](https://github.com/sasstools/sass-lint)

Running the linting:
`yarn lint`

### Running the tests

Mocha is used for writing tests.

Run them with:

```bash
$ yarn tests
```

For functional testing:

```bash
$ yarn test:routes
```

For accessibility testing:

```bash
$ yarn tests:a11y
```

For test coverage:

```bash
$ yarn test:coverage
```

For unit test coverage only:

```bash
$ yarn test:coverage-unit
```

### Running end to end tests

Integration tests are written using [CodeceptJS](https://codecept.io/) framework and reside in [`src/integration-test`](src/integration-test) directory. They are executed using Docker.

If you want to run them to see if your changes work, you will need to build a docker image containing your updates:

```bash
$ docker-compose build citizen-integration-tests
```

Then you can go to the [integration-tests](https://github.com/hmcts/cmc-integration-tests) project and run them with:

```bash
$ ./bin/run-local-citizen-tests.sh
```

If you didn't have a dockerized environment running it will be started up for you. If you prefer to start it up yourself beforehand, do:

```bash
$ ./bin/start-local-environment.sh
```

For more details on the dockerized environment please refer to integration-tests repository's[`README`](https://github.com/hmcts/cmc-integration-tests/blob/master/README.md) file.

### Playwright API Security and Functional Tests

API security and functional tests are written using [Playwright](https://playwright.dev/) and reside in the [`playwright/`](playwright/) directory. These tests run as part of the preview pipeline after the existing CodeceptJS functional tests pass.

**What they cover (70 tests):**

| Category | Tests | What it validates |
|----------|-------|-------------------|
| No Auth - Removed Endpoints | 9 | `/support/**` and `/cases/callbacks/**` return 401 without token |
| No Auth - Protected Endpoints | 6 | `/claims/**`, `/responses/**`, `/user/**` return 401 without token |
| Fake JWT | 5 | Forged tokens with fake signatures are rejected |
| Algorithm "none" Attack | 3 | Classic JWT bypass using `alg:none` is rejected |
| Expired Token | 3 | Expired JWTs are rejected |
| Role Escalation | 3 | Forged caseworker/admin role tokens are rejected |
| Path Traversal | 9 | URL encoding, double slashes, null bytes, semicolons are blocked |
| HTTP Method Tampering | 5 | Unexpected HTTP methods (DELETE, PATCH, TRACE) are rejected |
| Header Injection | 5 | X-Forwarded-For, X-Original-URL bypass attempts are rejected |
| SQL Injection | 10 | Malicious SQL payloads do not cause 500 errors |
| XSS (Reflected) | 4 | Script injection payloads are not reflected in responses |
| Health Check Sanity | 3 | `/health`, `/health/liveness`, `/health/readiness` remain accessible |
| Claim Lifecycle | 5 | Create claim, retrieve, link defendant, submit defence, verify response |

**Running locally:**

Set the required environment variables from the Azure Key Vault (see `Jenkinsfile_CNP` for the vault secret names). Connect to VPN before running.

```bash

```bash
# All tests (security + functional)
$ yarn test:playwright-preview

# Security tests only
$ npx playwright test --config=playwright/playwright.config.ts --project=api-security

# Functional tests only
$ npx playwright test --config=playwright/playwright.config.ts --project=api-functional
```

**Generating Allure report locally:**

```bash
$ npx allure generate allure-results -o allure-report --open
```

**In the pipeline:**

Tests run automatically in `afterSuccess('functionalTest:preview')`. The Allure report is published as a Jenkins artifact ("CMC API Security & Functional Test Report" link on the build page).

Based on DTSCCI-4008 API Security Testing Framework.

## Troubleshooting

### Warnings while running ```yarn install``` on yarn version 1.0.1

There is currently an open issue : https://github.com/yarnpkg/yarn/issues/3751

Example:

```
warning The case-insensitive file ..\cmc-citizen-frontend\node_modules\nyc\node_modules shouldn't be copied twice in one bulk copy
warning The case-insensitive file ..\cmc-citizen-frontend\node_modules\nyc\node_modules\ansi-regex shouldn't be copied twice in one bulk copy
```

## Preview Environment ##

We get a fully functional environment in Azure Kubernetes (AKS) per pull request. For more
info see: https://tools.hmcts.net/confluence/display/ROC/AKS+-+Azure+Managed+Kubernetes

## License ##
This project is licensed under the MIT License - see the [LICENSE](LICENSE.txt) file for details.

cmc-citizen-frontend

cmc-citizen-frontend Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

cmc-citizen-frontend

cmc-citizen-frontend Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README