https://github.com/ganapativs/react-npm-minimal-boilerplate
Minimal boilerplate for creating React NPM packages
https://github.com/ganapativs/react-npm-minimal-boilerplate
babel boilerplate creating-react decorators es6 es7 es8 eslint library module nodejs npm package react
Last synced: 4 months ago
JSON representation
Minimal boilerplate for creating React NPM packages
- Host: GitHub
- URL: https://github.com/ganapativs/react-npm-minimal-boilerplate
- Owner: ganapativs
- License: mit
- Created: 2016-12-05T16:29:25.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2018-05-01T07:09:45.000Z (about 7 years ago)
- Last Synced: 2025-02-14T02:11:23.340Z (5 months ago)
- Topics: babel, boilerplate, creating-react, decorators, es6, es7, es8, eslint, library, module, nodejs, npm, package, react
- Language: JavaScript
- Homepage:
- Size: 151 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Minimal boilerplate for creating React NPM packages
Boilerplate to get started with react NPM package instantly.
## Features
- ES6, ES7, ES8 support
- CSS in JS using [emotion](https://github.com/emotion-js/emotion)
- [Class properties support](https://github.com/tc39/proposal-class-fields)
- Decorators support
- [ESLint](http://eslint.org/) with [AirBnB style guide](https://www.npmjs.com/package/eslint-config-airbnb) & [Prettier](https://github.com/prettier/prettier)
- Transpilation to ES5
- Playground to test & manipulate components in realtime(webpack + react hot loader)
## Usage
1. Clone the repo: `git clone https://github.com/ganapativs/react-npm-minimal-boilerplate.git my-awesome-react-npm-package && cd $_`
2. Remove .git: `rm -rf .git`
3. Install dependencies: `yarn`
4. Playground with hot loader: `yarn run dev`
5. Lint: `yarn run lint`
6. Fix lint issues and prettify code 😎: `yarn run lint-fix`
7. Transpilation to ES5 in `dist` folder: `yarn run prepublish` (standard npm hook)
8. [Push package to your own Github repository](https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/)
9. Publish package: `yarn run publish`
## Todo
- [ ] Test cases
## License
MIT