README.md

React NPM Package Boilerplate

Boilerplate code for publishing a React NPM package.

• Bundled with Webpack
• Develop with Hot Module Replacement (HMR)
• Includes linting with ESLint
• Testing with Jest.

Usage

1. Install modules - yarn

2. Start example and start coding - yarn start

3. Run tests - yarn test

4. Bundle with - yarn build

5. To test if it works correctly in another project you can use npm npm install -S ../react-npm-component-boilerplate Note the relative path

E.g. this folder structure

    ./workspace/
        MyProject
        react-npm-boilerplate

Extra

Adjust your .eslintrc config file to your own preference.

NPM equivalent

yarn	npm
yarn	npm install
yarn test	npm run test
yarn build	npm run build

License

MIT © Dinesh Pandiyan