Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/midoahmed/rollup-react-library-starter
Template and quick-starter to create modern React library using Rollup.
https://github.com/midoahmed/rollup-react-library-starter
component-library create-react-library eslint jest library react rollup sass storybook typescript
Last synced: about 2 months ago
JSON representation
Template and quick-starter to create modern React library using Rollup.
- Host: GitHub
- URL: https://github.com/midoahmed/rollup-react-library-starter
- Owner: MidoAhmed
- License: mit
- Created: 2023-04-09T19:41:52.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2023-04-13T19:42:43.000Z (over 1 year ago)
- Last Synced: 2024-11-11T03:42:49.328Z (about 2 months ago)
- Topics: component-library, create-react-library, eslint, jest, library, react, rollup, sass, storybook, typescript
- Language: JavaScript
- Homepage:
- Size: 4.17 MB
- Stars: 43
- Watchers: 2
- Forks: 7
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# React component library template/boilerplate
Template and quick-starter to create your own modern React library includes awesome features and bandled using Rollup.
*Note: At date of writing this (April 2023), since the [create-react-library](https://github.com/transitive-bullshit/create-react-library) tool is no longer actively maintained (https://github.com/transitive-bullshit/create-react-library#readme) then I thought about creating this boilerplate to help bootstrap a modern react library with some nice features*
## Note
*This repository created for:*
1. Help to bootstrap your own react library with some nice features and
without bothering with configuration and saving time.
2. Learning purposes (especially how to bundle complicated things with Rollup).
## Intro
- This boilerplate uses [Rollup](https://rollupjs.org/) as a bundler https://rollupjs.org/
*As mentioned in [readme of create-react-library](https://github.com/transitive-bullshit/create-react-library#readme) there are some others tools(you can use it as a bundler) as an alternative to Rollup like [tsup](https://github.com/egoist/tsup), [tsdx](https://github.com/jaredpalmer/tsdx), or [microbundle](https://github.com/developit/microbundle).*
see also this artice https://transitivebullsh.it/javascript-dev-tools-in-2022#823feddaa1bb4edea19042852b0a5b54
## Features
- [Rollup](https://rollupjs.org/) for bundling
- Bundles `commonjs` and `es` module formats
- [Jest](https://facebook.github.io/jest/) & [React Testing Library](https://testing-library.com/) : For testing our components
- Support for [TypeScript](https://www.typescriptlang.org/)
- Sourcemap creation
- Support of CSS/SASS: For exporting components with style
- [Storybook](https://storybook.js.org/): For testing our components within the library itself as we design them
- Supports complicated peer-dependencies (example here is [Antd](https://ant.design/) so here the power of rollup-plugin-peer-deps-external we can use complicated peer dependency such Antd without having it bundled as a part of your module.)
- Optimizing bundle size: [@rollup/plugin-terser](https://www.npmjs.com/package/@rollup/plugin-terser) A Rollup plugin to generate a minified bundle with terser.
- Automatically externalize peerDependencies in a rollup bundle, thanks to [rollup-plugin-peer-deps-external](https://www.npmjs.com/package/rollup-plugin-peer-deps-external)
- Eslint
- Deploy Storybook to GitHub Pages
## Getting started
- Copy over the template by cloning this repository and install its dependencies:
```bash
git clone https://github.com/MidoAhmed/rollup-react-library-starter.git
cd rollup-react-library-starter
npm install
```
### Development:
- Storybook:
- Storybook gives you an easy way to see and use your components while working on them in your library project, without having to build an unnecessary testing page just to display them.
```bash
npm run storybook # runs the host Storybook application locally for quick and easy testing
```
Now, anytime you make a change to your library or the stories, the storybook will live-reload your local dev server so you can iterate on your component in real-time.
- Rollup watch and build:
- for Local development run rollup to watch your src/ module and automatically recompile it into dist/ whenever you make changes.
```bash
npm run dev # runs rollup with watch flag
```
### Scripts:
- `npm run build` : builds the library to `dist`
- `npm run dev` : builds the library, then keeps rebuilding it whenever the source files change.
- `npm test` : tests the library and show the coverage.
- `npm run lint` : runs eslint.
- `npm run storybook` : runs the host Storybook application locally for quick and easy testing
- `npm run build-storybook` : builds a static HTML/JS bundle that can easily be hosted on a remote server, so all members of your team can try your components.
- `npm run deploy-storybook` : build & deploy the storybook to GitHub Pages
### Publishing to npm:
publish to GitHub Packages registry:
- you need to have this in your ~/.npmrc
```bash
registry=https://registry.npmjs.org/
@YOUR_GITHUB_USERNAME:registry=https://npm.pkg.github.com
//npm.pkg.github.com/:_authToken=YOUR_AUTH_TOKEN
```
and run:
```bash
npm publish
```
## Tutorials and inspirations used to create this boilerplate
- big thanks to this tuto and his author : https://dev.to/alexeagleson/how-to-create-and-publish-a-react-component-library-2oe#adding-scss
## License
[MIT](LICENSE).