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. 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:

npm i

Running

You can run the project from a terminal with:

npm run dev

It should automatically reload when you save changes.

Git Hooks

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

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:

git config --local --unset core.hooksPath

Then run the pre-commit install commands again.

Documentation

Generate documentation webpages with the command:

npx typedoc --entryPointStrategy Expand src