Skip to content

runningdemo/react-component-npm

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

13 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Build Status

Boilerplate for creating React Npm packages with ES2015

The package is based on npm-base package by Kadira which is really great when you want to prepare Npm package. This one is prepared to be used as a starter point for React components which needs to be published on Npm.

It includes:

Also there is of course ES6 transpilation.

Usage

  1. Clone this repo
  2. Inside cloned repo run npm install && rm -rf .git && git init and update package.json with your package name.
  3. If you want to run tests: npm test or npm run test-watch. You need to write tests in __tests__ folder. You need at least Node 4 on your machine to run tests.
  4. If you want to run linting: npm run lint. Fix bugs: npm run lint-fix. You can adjust your .eslintrc config file.
  5. If you want to run transpilation to ES5 in dist folder: npm run prepublish (standard npm hook).
  6. If you want see how your plugin work in real word react application. Run npm run prepublish then go to example folder run npm install and run npm start.
  7. If you want to publish your package to npm just run npm publish.

License

MIT

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Packages

No packages published