Skip to content

City-of-Helsinki/parking-permits-admin-ui

Repository files navigation

Build Status Continuous Integration SonarCloud Analysis

Parking Permits Admin UI

Admin user interface for managing parking permits.

Related repositories:

Customer UI

Backend

Development

Prerequisites:

  • Node.js: 18.x or higher
  • yarn: 1.22.x or higher

The application requires a running parking-permits backend, you can find more details in this repo on how to set up the backend.

Clone the repository:

$ git clone git@github.com:City-of-Helsinki/parking-permits-admin-ui.git

Install the project:

$ cd parking-permits-admin-ui
$ yarn install

Make a local .env.template copy:

$ cp .env.template .env.development.local

Run the application in the development mode:

$ yarn start

Available Scripts

In the project directory, you can run:

yarn prepare

Install pre-commit hooks with husky. You only need to run it once after installing the project.

yarn start

Run the app in the development mode. Open http://localhost:3000/ to view it in the browser.

The page will reload if you make edits.
You will also see any lint errors in the console.
If you make changes to the .env files., you need to re-start the development server

yarn lint

Lint code with ESLint

yarn lint:fix

Lint code with ESLint and try to fix errors

yarn format

Format code with prettier

yarn test

Launches the test runner in the interactive watch mode.
See the section about running tests for more information.

yarn build

Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.
Your app is ready to be deployed!