helpwave web

The official helpwave web frontends.

---

Projects

This repository is split up into multiple subprojects using pnpm workspaces.

• helpwave tasks (see tasks)
• landing page of helpwave (see landing-page)
• library of helpwave (see lib)

Getting Started

Prerequisites

Before you can start you need to have these installed:

• Node.js
• pnpm (installation through npm npm install -g pnpm)

Setup

pnpm install

Usage

cd tasks # or any other page like e.g. landing-page
pnpm run dev

After that you should be able to open the project in the browser http://localhost:3000.

Storybook

The components of our library can be looked at in the storybook, where the different parameters of the component can be set individually.

This allows you to see which components already exist and how to use them. The current version can be seen here https://components.helpwave.de.

cd lib
pnpm run storybook

Testing

This project is tested with BrowserStack.

Linter

Our projects use linting with eslint to create a uniform code style. The linter can be used with:

pnpm run --filter "@helpwave/*" lint

pnpm run --filter "@helpwave/*" lint --fix

It's configuration and further explanation can be found in the eslint-config.

Scripts

The list of all our scripts can be found here.

Boilerplate generation

Execution with

• node generate_boilerplate <relative filepath>
• pnpm run generate <relative filepath> (within the projects)

All options can be seen with the --help flag

Example: node scripts/generate_boilerplate tasks/components/test