# PepperPlus UI

## Installation

First a description of how to install Node, then how to install this project.

### Node

Install Node 20.19 or higher.

Choose one of the options from [the Node.js website](https://nodejs.org/en/download). On Windows, the installer option seems easiest. On Linux (or macOS) you can use `nvm`. On macOS you can also use `brew`.

### Project

With a terminal in the project directory, run:

```shell
npm i
```

## Running

You can run the project from a terminal with:

```shell
npm run dev
```

It should automatically reload when you save changes.

## Environment

Copy `.env.example` to `.env.local` and adjust values as needed:

```shell
cp .env.example .env.local
```

## Git Hooks

To activate automatic linting, branch name checks and commit message checks, run:

```bash
npm run prepare
```

You might get an error along the lines of `Can't install pre-commit with core.hooksPath` set. To fix this, simply unset the hooksPath by running:

```bash
git config --local --unset core.hooksPath
```

Then run the pre-commit install commands again.

## Documentation

Generate documentation webpages with the command:

```shell
npx typedoc --entryPointStrategy Expand src
```
