Design System

Component library that contains a comprehensive set of guidelines, principles, and assets created using React and Storybook.

View Demo . Report Bug . Request Feature

Table Of Contents

• About the Project
• Built With
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Roadmap
• Contributing
• Authors
• Acknowledgements

About The Project

The @brunod-e-ignite-ui/react is a React component library, providing a collection of UI components designed for seamless integration into React applications.

The @brunod-e-ignite-ui/docs serves as documentation for the @brunod-e-ignite-ui library, providing comprehensive guidance and examples for developers. This documentation is a valuable resource for understanding the usage and features of the library.

The @brunod-e-ignite-ui/tokens, part of the @brunod-e-ignite-ui library, provides a set of design tokens. Design tokens are variables that store visual design decisions, such as colors, typography, and spacing, ensuring consistency across a design system.

Built With

React: Library for building user interfaces.
Storybook: An open-source tool for developing UI components in isolation.
RadixUI: A collection of low-level UI primitives for building composable and accessible user interfaces.
Typescript: Language for static typing.
Stitches: Library for styling React components.

Getting Started

This project is available at: brunod-e.github.io/design-system/

Prerequisites

• npm

npm install npm@latest -g

Installation

npm install @brunod-e-ignite-ui

or

npm install @brunod-e-ignite-ui/react @brunod-e-ignite-ui/tokens

Usage

To use library components or tokens just import then from @brunod-e-ignite-ui:

import { Box, BoxProps, Text } from '@brunod-e-ignite-ui/react';

import { colors } from '@brunod-e-ignite-ui/tokens';

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

• If you have suggestions for adding or removing projects, feel free to open an issue to discuss it, or directly create a pull request after you edit the README.md file with necessary changes.
• Please make sure you check your spelling and grammar.
• Create individual PR for each suggestion.

Creating A Pull Request

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

Authors

• Bruno D. - Fullstack Developer - Bruno D. - Built full library

Acknowledgements

• Rocketseat