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.

GitHooks

To activate automatic commits/branch name checks run:

git config --local core.hooksPath .githooks

If your commit fails its either: branch name != /description-of-branch , commit name != : description of the commit. : N25B-Num's

Documentation

Generate documentation webpages with the command:

npx typedoc --entryPointStrategy Expand src