Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/city-of-helsinki/mvj-ui

City of Helsinki land lease system UI
https://github.com/city-of-helsinki/mvj-ui

Last synced: about 2 months ago
JSON representation

City of Helsinki land lease system UI

Awesome Lists containing this project

README

        

[![Build](https://github.com/City-of-Helsinki/mvj-ui/workflows/Node.js%20CI/badge.svg)](https://github.com/City-of-Helsinki/mvj-ui/actions)
[![codecov](https://codecov.io/gh/City-of-Helsinki/mvj-ui/branch/master/graph/badge.svg)](https://codecov.io/gh/City-of-Helsinki/mvj-ui)

# MVJ UI
City of Helsinki Land lease UI

## What's in the box?

- [Typescript](https://www.typescriptlang.org/) Type checker
- [Yarn](https://yarnpkg.com/) Dependency manager
- [Vite](https://vitejs.dev/) Front-end tooling
- [Vitest](https://vitest.dev/) Testing framework
- [React](https://facebook.github.io/react/) User interface components
- [Redux](http://redux.js.org/) Predictable state container
- [Lodash](https://lodash.com/) Utility library
- [Eslint](http://eslint.org/) Linting utility

## Usage with Docker

Start the docker container with:

```bash
docker-compose up
```

The project is now live at [http://localhost:3000](http://localhost:3000)

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

```bash
docker exec -it mvj-ui bash
```

## Usage w/o Docker

#### 1. Yarn
Make sure you have [Yarn](https://yarnpkg.com/en/docs/install) installed globally.

#### 2. Install dependencies

```bash
yarn
```

#### 3. Add .env file

```bash
cp .env.example .env
```

#### 4. Start the development server

```bash
yarn start
```

#### 5. Compile the distribution build

```bash
yarn run build
```
## Test

#### Run the test suite

```bash
yarn test
```

#### Run the test suit in watch mode

```bash
yarn run test:watch
```

#### Generate the test coverage report

```bash
yarn run test:coverage
```