create-react-ui-lib-demo
v1.0.4
Published
Demo library created with create-react-ui-lib
Downloads
0
Readme
Create React UI Lib
A CLI tool that bootstraps simple Vite template for instant React UI library development.
- Unopinionated: no default styling, ESLint, pre-commit hooks — bring your own stuff if you need it.
- Type definitions are extracted using vite-plugin-dts.
- Bundles to ES and UMD modules, generates sourcemaps.
- Uses Storybook for docs which are easily deployed as GitHub pages.
Getting started
Run the command:
npm create react-ui-lib@latest
Publishing the library
- Build the package:
npm run build
- Open
package.json
, update package description, author, repository, remove"private": true
. - Run
npm publish
Publishing Storybook to GitHub pages
Storybook static is built to docs
directory which is under git. To publish it to GitHub Pages do this:
- Publish this repo to GitHub.
- Run
npm run build-storybook
, commitdocs
folder and push. - Create a separate GitHub Pages repo if you haven't yet.
- Set up GitHub pages for this project to build from
docs
folder frommain
branch.- To do this go to this repo's settings and open
Pages
section (menu on the left side). SelectSource
->Deploy from a branch
, selectBranch
->main
and/docs
folder.
- To do this go to this repo's settings and open
Feedback
Tell me about your experience with Create React UI Lib. Support the project by giving it a start on GitHub.