Table of Contents

• Tech Stack
• Requirement
• Getting Started
• Git Hooks

This is the frontend SPA layer of Metrik, the 4-key-metrics measurement tool.

Tech Stack

• React
• Typescript
• Recharts
• Webpack
• Jest & Testing-Library For React

Requirement

Node Version >= 10

Getting Started

Run Locally

Checkout the repo to local and go to the project folder: ${REPO_FOLDER}/frontend

• Install dependencies

npm i

• Start up app locally

npm run start:local-api

Then you can access http://localhost:2333 to check web page.

Test the project

• Test

npm test

Then coverage folder is built in ${REPO_FOLDER}/frontend, which includes all the test coverage reports.

Build bundles

• Build

npm run build:prod

• Build with Analyzer

npm run build:prod:analyze

Then dist folder is built in ${REPO_FOLDER}/frontend, which includes all the bundles.

Git Hooks

• use pre-commit to do type and code style checking
• use pre-push to do unit test and test coverage checking