https://github.com/helpwave/web
The official web application of helpwave
https://github.com/helpwave/web
emergency emergency-medical-services emergency-services hacktoberfest nextjs react reactjs
Last synced: 10 months ago
JSON representation
The official web application of helpwave
- Host: GitHub
- URL: https://github.com/helpwave/web
- Owner: helpwave
- License: mpl-2.0
- Created: 2022-09-29T21:08:47.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2025-04-04T15:17:46.000Z (10 months ago)
- Last Synced: 2025-04-04T16:34:25.842Z (10 months ago)
- Topics: emergency, emergency-medical-services, emergency-services, hacktoberfest, nextjs, react, reactjs
- Language: TypeScript
- Homepage: https://staging-tasks.helpwave.de
- Size: 4.33 MB
- Stars: 13
- Watchers: 1
- Forks: 5
- Open Issues: 93
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# helpwave web
The official helpwave web frontends.
[](https://codespaces.new/helpwave/web)
---
## [Projects](./documentation/structure.md)
This repository is split up into multiple subprojects using [pnpm](https://pnpm.io) workspaces.
- helpwave tasks (see [tasks](/tasks))
- landing page of helpwave (see [landing-page](/landing-page))
- library of helpwave (see [lib](/lib))
## Getting Started
### Prerequisites
Before you can start you need to have these installed:
- [Node.js](https://nodejs.org/)
- [pnpm](https://pnpm.io/) (installation through npm `npm install -g pnpm`)
### Setup
```shell
pnpm install
```
### Usage
```shell
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`](http://localhost:3000).
## Storybook
The components of our [library](lib) 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.
```shell
cd lib
pnpm run storybook
```
## Testing
This project is tested with [BrowserStack](https://www.browserstack.com).
## Linter
Our projects use linting with `eslint` to create a uniform code style. The linter can be used with:
```shell
pnpm run --filter "@helpwave/*" lint
```
It's configuration and further explanation can be found in the [eslint-config](eslint-config/README.md).
## Scripts
The list of all our scripts can be found [here](documentation/scripts.md).
### Boilerplate generation
Execution with
- `node generate_boilerplate `
- `pnpm run generate ` (within the projects)
All options can be seen with the `--help` flag
Example: `node scripts/generate_boilerplate tasks/components/test`