/storybook

Primary LanguageJavaScriptMIT LicenseMIT

Chromatic

Chromatic's Intro to Storybook React template

This template ships with the main React and Storybook configuration files you'll need to get up and running fast.

🚅 Quick start

  1. Create the application.

    Use degit to get this template.

    # Clone the template
npx degit chromaui/intro-storybook-react-template taskbox

  2. Install the dependencies.

    Navigate into your new site’s directory and install the necessary dependencies.

    # Navigate to the directory
cd taskbox/

# Install the dependencies
yarn

  3. Open the source code and start editing!

    Open the taskbox directory in your code editor of choice and building your first component!

  4. Browse your stories!

    Run yarn storybook to see your component's stories at http://localhost:6006

🔎 What's inside?

A quick look at the top-level files and directories included with this template.

.
├── .storybook
├── node_modules
├── public
├── src
├── .eslintrc.cjs
├── .gitignore
├── .index.html
├── LICENSE
├── package.json
├── yarn.lock
├── vite.config.js
└── README.md

  1. .storybook: This directory contains Storybook's configuration files.

  2. node_modules: This directory contains all of the modules of code that your project depends on (npm packages).

  3. public: This directory will contain the development and production build of the site.

  4. src: This directory will contain all of the code related to what you will see on your application.

  5. .eslintrc.cjs: This file is the configuration file for ESLint, a tool for identifying and reporting on patterns found in ECMAScript/JavaScript code.

  6. .gitignore: This file tells git which files it should not track or maintain during the development process of your project.

  7. .index.html: This is the HTML page that is served when generating a development or production build.

  8. LICENSE: The template is licensed under the MIT licence.

  9. package.json: Standard manifest file for Node.js projects, which typically includes project specific metadata (such as the project's name, the author among other information). It's based on this file that npm will know which packages are necessary to the project.

  10. yarn.lock: This is an automatically generated file based on the exact versions of your npm dependencies that were installed for your project. (Do not change it manually).

  11. vite.config.js: This is the configuration file for Vite, a build tool that aims to provide a faster and leaner development experience for modern web projects.

  12. README.md: A text file containing useful reference information about the project.

Contribute

If you encounter an issue with the template, we encourage you to open an issue in this template's repository.

Learning Storybook

  1. Read our introductory tutorial at Learn Storybook.
  2. Learn how to transform your component libraries into design systems in our Design Systems for Developers tutorial.
  3. See our official documentation at Storybook.