https://github.com/wadehrarshpreet/react-create-library
CLI tools to generate boilerplate to create component based library
https://github.com/wadehrarshpreet/react-create-library
boilerplate cli library library-generator react
Last synced: about 1 year ago
JSON representation
CLI tools to generate boilerplate to create component based library
- Host: GitHub
- URL: https://github.com/wadehrarshpreet/react-create-library
- Owner: wadehrarshpreet
- License: mit
- Created: 2019-11-24T15:28:44.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2022-12-04T23:57:50.000Z (over 3 years ago)
- Last Synced: 2025-04-19T13:56:29.580Z (about 1 year ago)
- Topics: boilerplate, cli, library, library-generator, react
- Language: JavaScript
- Size: 3.51 MB
- Stars: 10
- Watchers: 3
- Forks: 2
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# react-create-library
> Command Line tool to generate boilerplate for your react library.
Create React Library with no build configuration.
## Features
- User friendly CLI Interface
- Handles all modern JS features
- Bundles `cjs`, `esnext`, `umd` and `es` module formats
- Support for `TypeScript` and `flow` type System
- Support for documentation library like `docz`, `storybook` and `react-styleguidist`
- Support for different styling like `css`, `less`, `scss`, `emotion` and `styled-component`
- [Standard-version](https://www.npmjs.com/package/standard-version) for manage versioning and CHANGELOG generation
- Prettier, Eslint & Stylelint added to maintain the code quality & readability.
- [Rollup](https://rollupjs.org/) for bundling & sourcemap generation
- [Babel](https://babeljs.io/) for transpiling
- [Jest](https://facebook.github.io/jest/) for testing
- Working example setup using [create-react-app](https://github.com/facebook/create-react-app)
## Install globally
This package requires node >= 8.
```sh
npm install -g react-create-library
```
## Usage
```sh
react-create-library my-library
```
## Using npx
```sh
npx react-create-library my-library
```
Interactive CLI, answer few questions and choose modules required for development.
### CLI Options
```
Usage: react-create-library [Options]
Options:
-V, --version output the version number
--verbose print additional logs
--pm Package Manager (npm or yarn)
--type Type System for project one of default,typescript,flow (default: "none")
--doc Documentation Library one of none,docz,storybook,react-styleguidist (default: "docz")
--style Styling Library one of inline,css,less,scss,emotion,styled-component (default: "inline")
-l, --license License of Project (default: "MIT")
-s, --skip Skip all question and create project with defaults
-h, --help output usage information
Node version require >= 8 & npm >= 5
```
If something doesn’t work, please [file an issue](https://github.com/wadehrarshpreet/react-lib/issues/new)