💅🏼 ui-components

The ui-components repository is a collection of React components, crafted with Typescript and Styled Components. The components are organized according to the Atomic Design system and provides a versatile set of building blocks to create beautiful and consistent user interfaces.

📖 Table of Contents

• Development
• Contributing

👨🏻‍💻 Development

To get started with this project, follow these step:

1. Clone the repository: Clone the repository to your local machine.
2. Install dependencies: Install the dependencies using yarn install
3. Run Storybook: Run storybook with yarn storybook

Open http://localhost:6006 with your browser to see the result.

👫 Contributing

To contribute to the ui-components package, follow these step:

1. Clone the Repository: Clone the repository to your local machine.
2. Create a Branch: Create a new branch for your changes using a descriptive name: git checkout -b feature/my-new-feature.
3. Make Changes: Make your desired changes and improvements to the codebase.
4. Commit Changes: Commit your changes with a clear and concise commit message: git commit -m "Add a new feature".
5. Push Changes: Push your changes to your development branch: git push origin feature/my-new-feature.
6. Update the CHANGELOG: Update the CHANGELOG.md file with the new changes.
7. Open a Pull Request: Visit the repository and open a Pull Request. Describe your changes, and submit the pull request.