README.md

MVJ UI

City of Helsinki Land lease UI

What's in the box?

• Typescript Type checker
• Yarn Dependency manager
• Vite Front-end tooling
• Vitest Testing framework
• React User interface components
• Redux Predictable state container
• Lodash Utility library
• Eslint Linting utility
• Prettier Formatting utility

Usage with Docker

Start the docker container with:

docker-compose up

The project is now live at http://localhost:3000

You can log into the container to execute some commands like so:

docker exec -it mvj-ui bash

Usage w/o Docker

1. Yarn

Make sure you have Yarn installed globally.

2. Install dependencies

yarn

3. Add .env file

cp .env.example .env

4. Start the development server

yarn start

5. Compile the distribution build

yarn run build

Test

Run the test suite

yarn test

Run the test suit in watch mode

yarn run test:watch

Generate the test coverage report

yarn run test:coverage

Automatic Code formatting

Install Prettier extension for VSCode. The editor will format TypeScript and SCSS files automatically on save.