Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/digitalservicebund/wie-viele-menschen
A small website that displays how many of your users in Germany statistically have some type of disability.
https://github.com/digitalservicebund/wie-viele-menschen
a11y accessibility statistics
Last synced: about 8 hours ago
JSON representation
A small website that displays how many of your users in Germany statistically have some type of disability.
- Host: GitHub
- URL: https://github.com/digitalservicebund/wie-viele-menschen
- Owner: digitalservicebund
- License: mit
- Created: 2024-04-29T09:34:32.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2024-11-18T04:31:57.000Z (3 months ago)
- Last Synced: 2024-12-18T20:21:57.878Z (about 2 months ago)
- Topics: a11y, accessibility, statistics
- Language: Vue
- Homepage:
- Size: 1.26 MB
- Stars: 2
- Watchers: 2
- Forks: 2
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# 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](https://nodejs.dev/en/about/releases/), which is V22 at the time of writing.
There is a `.node-version` file to simplify setup using [nodenv](https://github.com/nodenv/nodenv).
### Testing
For E2E and a11y testing with [Playwright](https://playwright.dev/docs/intro) you will need to install the supported browsers:
```bash
npx playwright install
```
### Git Hooks
For the provided Git hooks you will need to install [lefthook](https://github.com/evilmartians/lefthook/blob/master/docs/full_guide.md)
(git hook manager):
```bash
brew install lefthook
./run.sh init
```
## Install
```bash
npm install
```
## Development
### Run locally
Start the development server on `http://localhost:3000`:
```bash
npm run dev
```
### Testing
The applications have
- end-to-end tests (using [Playwright](https://playwright.dev/docs/intro))
- accessibility tests (using [Playwright](https://playwright.dev/docs/intro) and [Axe](https://www.deque.com/axe/))
**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](https://eslint.org/docs/latest/) for linting and [Prettier](https://prettier.io/docs/en/). 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:
```bash
npm run build
```
Locally preview production build:
```bash
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](CODE_OF_CONDUCT.md).
🇩🇪
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](CODE_OF_CONDUCT_DE.md).
### 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.