A2J UI component library prototyping

Feel free to add more examples.

Prerequisites

Node.js and Homebrew

We aim to use the current active LTS version of Node.js, which is V22 at the time of writing. There is a .tool-versions file to simplify setup using nodenv (install Node version by running nodenv install) or asdf (check and install used Node version by running asdf current) and a .nvmrc file to simplify setup using nvm (check and install Node version by running nvm use).

Additionally we use Git Hooks that can be installed with Homebrew, please check if brew is available on your machine with brew -v command.

For the provided Git hooks you will need to install lefthook (git hook manager) brew install lefthook. Afterwards execute lefthook install to initialize the hooks or run lefthook run pre-commit before commiting new changes. See lefthook.yml for more details in regards to the currently configured git hooks.

Getting started

Project was set up with npm create vite@latest and the react-ts template.

# install dependencies
npm i

Usage

Local development URL should be http://localhost:5173/, have a look at the terminal output.

# start local development
npm run dev

Contributing

Deutsche sprache weiter unten

Everyone is welcome to contribute! You can contribute by giving feedback, adding issues, answering questions, providing documentation or opening pull requests. Please always follow the guidelines and our Code of Conduct.

To contribute code, simply open a pull request with your changes and it will be reviewed by someone from the team. By submitting a pull request you declare that you have the right to license your contribution to the DigitalService and the community under the license picked by the project.

Mitwirken

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

Um Code beizutragen erstelle einfach einen Pull Requests mit deinen Änderungen, dieser wird dann von einer Person aus dem Team überprüft. Durch das Eröffnen eines Pull-Requests erklärst du ausdrücklich, dass du das Recht hast deine Beitrag an den DigitalService und die Community unter der vom Projekt gewählten Lizenz zu lizenzieren.