Skip to content

digitalservicebund/wie-viele-menschen

Repository files navigation

How many people

A small website that displays how many of your users in Germany statistically have some type of disability.

Prerequisites

Node.js

We aim to use the current active LTS version of nodejs, which is V22 at the time of writing. There is a .node-version file to simplify setup using nodenv.

Testing

For E2E and a11y testing with Playwright you will need to install the supported browsers:

npx playwright install

Git Hooks

For the provided Git hooks you will need to install lefthook (git hook manager):

brew install lefthook
./run.sh init

Install

npm install

Development

Run locally

Start the development server on http://localhost:3000:

npm run dev

Testing

The applications have

Test commands

  • Run all tests: npm run tests
  • Run E2E tests: npm run test:e2e
  • Run A11y tests: npm run test:a11y

Code quality checks (linting & formatting)

The project uses ESLint for linting and Prettier. for formatting.

Commands

  • Check formatting: npm run format:check
  • Autofix formatting issues: npm run format:fix
  • Check lint: npm run lint:check
  • Autofix lint issues: npm run lint:fix
  • Check style (formatting & linting): npm run style:check
  • Autofix style issues (formatting & linting): npm run style:fix

Production

Build the application for production:

npm run build

Locally preview production build:

npm run preview

Contributing

🇬🇧 Everyone is welcome to contribute the development of the wie-viele-menschen. You can contribute by opening pull request, providing documentation or answering questions or giving feedback. Please always follow the guidelines and our Code of Conduct.

🇩🇪
Jede:r ist herzlich eingeladen, die Entwicklung der wie-viele-menschen mitzugestalten. Du kannst einen Beitrag leisten, indem du Pull-Requests eröffnest, die Dokumentation erweiterst, Fragen beantwortest oder Feedback gibst. Bitte befolge immer die Richtlinien und unseren Verhaltenskodex.

Contributing code

🇬🇧 Open a pull request with your changes and it will be reviewed by someone from the team. When you submit a pull request, you declare that you have the right to license your contribution to the DigitalService and the community. By submitting the patch, you agree that your contributions are licensed under the MIT license.

Please make sure that your changes have been tested befor submitting a pull request.

🇩🇪
Nach dem Erstellen eines Pull Requests wird dieser von einer Person aus dem Team überprüft. Wenn du einen Pull-Request einreichst, erklärst du dich damit einverstanden, deinen Beitrag an den DigitalService und die Community zu lizenzieren. Durch das Einreichen des Patches erklärst du dich damit einverstanden, dass deine Beiträge unter der MIT-Lizenz lizenziert sind.

Bitte stelle sicher, dass deine Änderungen getestet wurden, bevor du einen Pull-Request sendest.