Skip to content

helpwave/web

This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Folders and files

NameName
Last commit message
Last commit date
Dec 17, 2024
Dec 17, 2024
Nov 14, 2024
Dec 27, 2024
Mar 12, 2024
Dec 27, 2024
Dec 27, 2024
Dec 27, 2024
Dec 27, 2024
Dec 27, 2024
May 6, 2023
Jun 16, 2023
Feb 4, 2023
Dec 17, 2024
Sep 29, 2022
Mar 17, 2024
Sep 9, 2023
Dec 27, 2024
Oct 1, 2024
Oct 17, 2023

Repository files navigation

helpwave web

The official helpwave web frontends.

Open in GitHub Codespaces

OpenSSF Scorecard


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

To get started you will have to in install pnpm. After that you can use the following commands to start one of our projects.

pnpm install
cd <project> # e.g. tasks, 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 used with:

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

It is configured 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