Soller Design System

Welcome to the repository of my Design System. I developed this project initially for study purposes and also so that I can use it in my personal projects. Feel free to use it in your projects or as a basis to start your own design system!

What is a Design System?

The Design System consists of a set of design patterns, components, and guidelines to ensure a consistent user experience across various applications within a company. Using a Design System facilitates standardization and maintenance of design components across all products, resulting in a more cohesive and user-friendly interface.

Advantages of a Design System

Implementing a Design System brings the following advantages:

1. Consistency: Ensures a consistent look and feel throughout the user interface, enhancing the overall user experience.

2. Productivity: Reduces redundancy by providing a reusable set of components, saving time and effort during development.

3. Maintainability: Facilitates updates and changes by consolidating design elements in a single repository, making maintenance easier.

Monorepo Architecture

This repository adopts the Monorepo architecture, consolidating all related components, styles, and assets into a single repository. This approach offers several advantages:

1. Unified development environment: Provides a standardized development environment for all team members, minimizing configuration discrepancies.

2. Centralized configuration: All configurations, dependencies, and tools are consolidated, simplifying the development workflow.

3. Global changes: Modifications and updates have a global impact, ensuring consistent changes throughout the system.

Tools Used

• Turbo Repo
• Changesets
• Tsup
• Storybook
• React
• Typescript
• Styled Components
• Radix UI

How to Use

To start using the Design System, clone the repository into your local environment and install the dependencies using NPM:

git clone https://github.com/eduardosoller/design-system.git
cd design-system
npm install

Contributing

You can also help me improve and expand this project with enhancements and the creation of new components. To contribute, follow these steps:

1. Fork the repository.
2. Create a new branch for your feature (git checkout -b feature/MyFeature).
3. Commit your changes (git commit -am 'Added an awesome feature').
4. Push to the branch (git push origin feature/MyFeature).
5. Open a Pull Request.

License

This project is licensed under the MIT License. See the LICENSE file for more details.