react-lib-starter

中文文档

A boilerplate for creating a React library, using Storybook.

Getting started

git clone https://github.com/senntyou/react-lib-starter.git --depth=1

cd react-lib-starter

npm install             # install dependencies

npm run storybook       # develop using storybook

npm run build           # build distribution files

Features

• less, scss style languages support.
• Flow syntax, jest + enzyme test support.
• Using storybook to develop, preview, deploy static site.

Project

- src
  - index.{js,jsx}           # js entry file
  - styles
    - index.{less,scss}      # style entry file

- .storybook                 # for storybook
- stories                    # for storybook

By default, styles use less language, if you want to use scss language, you should modify package.json by:

"scripts": {
  - "build:styles": "npm run build:less",
  + "build:styles": "npm run build:scss",
}

Notes

• .js files only for pure JavaScript, and .jsx for React components.