https://github.com/intuit/design-systems-cli

A CLI toolbox for creating design systems.
https://github.com/intuit/design-systems-cli

hacktoberfest

Last synced: 4 days ago
JSON representation

A CLI toolbox for creating design systems.

• Host: GitHub
• URL: https://github.com/intuit/design-systems-cli
• Owner: intuit
• License: mit
• Created: 2020-01-06T22:35:51.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2024-10-31T01:44:08.000Z (12 days ago)
• Last Synced: 2024-10-31T02:27:04.246Z (12 days ago)
• Topics: hacktoberfest
• Language: TypeScript
• Homepage: https://intuit.github.io/design-systems-cli/#/
• Size: 14.4 MB
• Stars: 402
• Watchers: 5
• Forks: 85
• Open Issues: 65
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: .github/CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        


  


  


  
A CLI toolbox for creating design systems in minutes


  
Uses: Typescript, CSS, styled-components support

  
Outputs: CJS and MJS

  
No tooling configuration required




















## Overview

Design-systems-cli is basically a [Create React App](https://github.com/facebook/create-react-app) for design systems.

The main benefit it brings you as a developer is time savings. Setting up all of the monorepo, [storybook](https://storybook.js.org/), and build tools for a design system takes over a week if you piece it together yourself. You can do it with this project in minutes.

### Features

:star: Scaffold components and entire design systems

:star: Build your components for multiple outputs (cjs and esm)

:star: Write styles with styled-components or css-modules

:star: Craft excellent components using Storybook

:star: Let component consumer try your components with playroom

:star: Testing and linting support

:star: Typescript supported out of the box

:star: Track the size of your components and debug the changes

For the full documentation, go [here](https://intuit.github.io/design-systems-cli/#).

## Installation

Ensure you have the following softwares installed:

* `Node >= 10.18.1` - [Installation guide](https://nodejs.org/en/download/)

* `Yarn` - [Installation guide](https://classic.yarnpkg.com/en/docs/install)

If node-gyp throws errors during installation, installation may still be successful

### To get started:

To get set up, fork and clone the project then run the following command:

```sh

yarn && yarn start

```

### Creating a new Plugin

To scaffold a new plugin inside this repo run the following command:

```sh

yarn run create:plugin "my plugin"

```

## Contributing

Feel free to open an [issue](https://github.com/intuit/design-systems-cli/issues) or a [pull request](https://github.com/intuit/design-systems-cli/pulls)!

Make sure to read our [code of conduct](./CODE_OF_CONDUCT.md).

We actively welcome pull requests. Learn how to [contribute](./CONTRIBUTING.md).

## Contributors ✨

Thank you to all these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):

  

    
Adam Dierkens
💻 🎨 🤔 📖 ⚠️

    
Andrew Lisowski
💻 🎨 📖 🤔 🚇 ⚠️

    
Tyler Krupicka
💻 📖 ⚠️

    
Kendall Gassner
💻 📖 ⚠️

    
Kelly Harrop
🎨

    
Peter Mikitsh
📖

    
WhiteSource Renovate
💻 ⚠️

  

  

    
mishavp2001
💻

    
Raj Vasikarla
💻 📖 ⚠️

    
Brandon Orther
📖 💻

    
alan-cruz2
💻

    
hainessss
💻

    
Athitya Kumar
💻

    
Jason Rundell (he/him)
📖 ⚠️ 💻

  

  

    
Reuben
📖

    
my99N
📖 ⚠️ 💻

    
anjaliguptaz
📖

    
chaopan
⚠️

    
Talor Anderson
💻 📖 ⚠️

    
Spencer Hamm
💻 📖 ⚠️

    
Adil Malik
⚠️

  

  

    
Salil Cuncoliencar
📖 ⚠️ 💻

    
Gaurav Kesarwani
📖 ⚠️ 💻

    
Nicolas Hoizey
📖

    
Harris Borawski
💻

    
Sean Powell
💻

    
melindali255
📖 ⚠️ 💻

    
Yucho Ho
💻

  

  

    
Jeremiah Zucker
⚠️

    
Abd El-Ghazali
📖 💻

  

This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!