tuturuleo-ui
v1.0.1
Published
react components library
Downloads
1
Readme
react-library-starter
⚡ A library starter kit and bundler for your React projects, powered by Rollup.
Features
- React with TypeScript support
- Rollup for bundling (with a customizable bundler config file)
- Babel for transpiling
- Storybook for development and component explorer
- SVGR support
- Uses TailwindCSS 2.0
- Linting before commit support with ESLint, Husky and Lint Staged
- Supports CSS modules configurable with PostCSS
- styled-components support
- react-uuid for component key indexing
- Supports CJS, ESM and UMD formats
- Sourcemap creation
Development
Clone this repo and run the following commands to start development with Storybook.
npm install --production=false
npm run storybook
Go to localhost:6006
and you should see something like this.
Building
To build your project, run npm run build
.
Publishing
npm publish
This builds commonjs
, esm
, and umd
versions of your module to dist/
and then publishes your module to npm
.
Make sure that any npm modules you want as peer dependencies are properly marked as peerDependencies
in package.json
. The rollup config will automatically recognize them as peers and not try to bundle them in your module.
License
MIT © Rhaidzsal Ali