Skip to content

dedevillela/ignite-lab-design-system

Repository files navigation

Ignite Lab - Design System

GitHub package.json dependency version (prod) GitHub package.json dependency version (prod) GitHub package.json dependency version (prod) GitHub package.json dependency version (prod) view @latest storybook GitHub release PRs welcome GitHub branch checks state GitHub Lisense

Wallpaper - 1400x900

A simple Design System project with React components using Tailwind CSS1, TypeScript2 and Storybook3 for documentation.


🚀 Getting Started

  • From your terminal, clone the repository into your local machine, chage your current folder to the project folder you just created, and install the dependencies.
git clone https://github.com/dedevillela/ignite-lab-design-system.git && \
cd ignite-lab-design-system && \
npm install
  • Start the development server.
npm run dev
  • Add a new component or edit the existing ones inside the src/components folder.

📃 Documenting

  • Start the Storybook server.
npm run storybook
  • To document your component in Storybook, add a file matching the component name and use the extension .stories.tsx.

📝 License

Footnotes

  1. Tailwind CSS

  2. TypeScript

  3. Storybook Docs