https://github.com/joannajjliu/cra-storybook

storybook starter tutorial
https://github.com/joannajjliu/cra-storybook

Last synced: 5 days ago
JSON representation

storybook starter tutorial

• Host: GitHub
• URL: https://github.com/joannajjliu/cra-storybook
• Owner: joannajjliu
• Created: 2020-08-05T04:16:36.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2020-08-06T15:05:26.000Z (over 4 years ago)
• Last Synced: 2025-01-08T12:32:03.816Z (about 1 month ago)
• Language: CSS
• Homepage: https://www.npmjs.com/package/jl-cra-storybook
• Size: 297 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).

## References

- [storybook and create react app set-up](https://fathomtech.io/blog/create-a-react-component-library-using-create-react-app/)

- [storybook configuration](https://www.learnstorybook.com/intro-to-storybook/react/en/simple-component/)

### Instructions

- run `yarn` to install dependencies

- run `yarn run compile` to compile your library to the dist folder

#### Test your components:

- Test in storybook (where the components reside presently): run `yarn storybook` (opens in port 9009)

- Test in react application: run `yarn start` (opens in port 3000)

#### Publish your library:

- In package.json file, change "name" field to a unique npm library name

- Create a npm account if you haven't already

- run `npm publish` to publish your library (from the dist folder) to npm

  - May prompt you to log in