Generator-react-component-boilerplate NPM

generator-react-component-boilerplate

biolerplate for react components

Installation

First, install Yeoman and generator-react-component-boilerplate using npm (we assume you have pre-installed node.js).

npm install -g yo
npm install -g generator-react-component-boilerplate

Then generate your new project:

yo react-component-boilerplate

Getting To Know Yeoman

Yeoman has a heart of gold.
Yeoman is a person with feelings and opinions, but is very easy to work with.
Yeoman can be too opinionated at times but is easily convinced not to be.
Feel free to learn more about Yeoman.

How to develop your component

Source

Your component source code is in src. You can use JSX and ES6 syntax freely in your component source; it will be transpiled to lib with Babel before being published to npm so that your users will simply be able to include it.

It's a great idea to add a description, documentation and other information to your README.md file, to help people who are interested in using your component.

Example & Preview

Preview your component with LiveReload:

npm run dev

A webserver will be started on localhost:8000.

You can use this playpen to test your component, and then publish it as live examples to GitHub Pages, which is a great way to let potential users try out your component and see what it can do.