HELERM UI

This is a front-end project for Helsinki Electronic Records Management Classification System.

The project structure is based on create-react-app (https://create-react-app.dev/).

Looking for the backend code? It's in this repository: helerm - Helsinki Electronic Records Management Classification System

Requirements

• node ^16.19.0

Install from source

Make sure you have Yarn installed globally.

1. Clone the project:

$ git clone https://github.com/City-of-Helsinki/helerm-ui.git
$ cd helerm-ui

2. Install project dependencies

$ yarn              # Install project dependencies

3. Add needed environmental variables

Add these by copying the .env.example to .env and adding the values to the file, or directly through process.env.

You will need to have the CLIENT_* and JWT_TOKEN parameters for the Helsinki Tunnistamo, or run your own https://github.com/City-of-Helsinki/tunnistamo instance.

Running the app locally:

$ yarn start:dev    # Launch on local environment

Navigate to http://localhost:3000

Running the app in docker

Requires you to setup a port where the application will be running to your .env file, f.ex.

PORT=3000

$ docker-compose up --build # Launches the containerized version of the application

Navigate to http://localhost:3000