Skip to content

patrickluizdev/ignite-lab-design-system

Repository files navigation

Design System with Storybook

This repository contains a project that demonstrates the use of Storybook as a Design System for React components. Storybook is a tool that allows you to create and view user interface components in isolation. With Storybook, developers can build, document, and test components independently of the rest of the application, making it easier to develop and maintain complex user interfaces.

Some of the key features of Storybook include:

  1. Isolated Development: Allows you to develop and view components in isolation, making it easier to identify and fix issues more efficiently.

  2. Automatic Documentation: Automatically generates documentation for components, including properties, usage examples, and descriptions, making it easier for other developers to understand and use the components.

  3. Support for Different Frameworks: Supports various frameworks such as React, Vue.js, Angular, among others, allowing developers to choose the best technology for their projects.

  4. Visual Testing: Allows you to visually test components in different states and in different browsers, ensuring consistency and quality of the user interface.

  5. Continuous Integration: Can be integrated into continuous integration pipelines to automate the generation of documentation and component tests.

  6. Addons and Plugins: Has a wide variety of addons and plugins that add extra functionality, such as accessibility support, integration with design services, among others.

In summary, Storybook is a powerful tool for developing user interfaces, enabling faster, more consistent, and high-quality development.

Project Prototype

Dependencies

  • typescript: A programming language that adds types to JavaScript, ensuring better code security and maintainability.
  • storybook: A library for developing UI components, allowing the construction of an interactive and documented component library.
  • tailwindcss: A utility-first CSS framework that helps create flexible and responsive designs with a class-based approach.
  • vite: A fast build tool for JavaScript and TypeScript projects, with support for rapid development and hot module replacement.
  • autoprefixer: A PostCSS plugin to automatically add prefixes to your CSS, ensuring better browser compatibility.
  • eslint: A linting tool for JavaScript and TypeScript, which helps maintain clean and consistent code.
  • postcss: A post-processing tool to transform CSS with JavaScript, used to add vendor prefixes, minify, and other transformations.

How to Use

  1. Clone this repository.
  2. Install dependencies with npm install.
  3. Start Storybook and the Application with npm start.
  4. View and interact with the components in Storybook at http://localhost:6006.
  5. View and interact with the Application at http://localhost:5173.

CI/CD

This project has continuous integration (CI) and continuous deployment (CD) configured. The deployments can be accessed at the following links:

Screenshots

Storybook Dashboard Image

Application Image

About

Documentação de componentes com Storybook

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors