PNC React based Web UI (v2)

Bootstrapping

This project was bootstrapped with Create React App. Too see more details about bootstrapping, open documentation/bootstrapping.md

Changelog

Changelog

Prerequisites

1. See "engines" in package.json for minimum version requirements (for example node and npm)
2. Prettier, see documentation/prettier.md
3. EditorConfig, see documentation/editor-config.md (optional)

Code Editor

Preferred code editor is Visual Studio Code. Settings config file is also included in .vscode directory.

Workflows

Contribute using GitHub flow, once new Pull request is created, GitHub Workflows are started and jobs consisting of building and testing are executed.

To see more details about scripts added by Create React App, open documentation/README_CRA.md.

First prepare project locally:

git clone <yourGitForkUrl> pnc-web-ui-react
cd ./pnc-web-ui-react/
npm install

Then choose one of the following options:

1) Development

npm start   # runs the app in the development mode and open http://localhost:3000

2) Build

npm run build   # builds the app for production to the build folder

Release

not available yet

Unit Tests

Unit tests are integrated for all components, you can use the following commands to run the unit tests for modified components:

npm run test   # run tests for those components that was modified.

If you want to run all tests, press a.

Update Snapshots for Unit Test

Snapshot Test was integrated in some components. Update for snapshots is required if the UI layout is changed.

To update the snapshops of a component:

1) Run unit test

npm run test   # run tests for those components that was modified.

Make sure you have snapshot failed only from the console output.

2) Trigger update snapshots

Press u to update failing snapshots.