aaa-header
v1.0.6
Published
Global AAA Header component for React web applications
Readme
Global AAA Header component for React web applications
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 linting with ESLint and testing with Mocha, Enzyme and JSDOM.
Also there is of course ES6 transpilation.
Usage
- Clone this repo
- Inside cloned repo run
npm install - If you want to run tests:
npm testornpm run testonlyornpm run test-watch. You need to write tests inspecsfolder. You need at least Node 4 on your machine to run tests. - If you want to run linting:
npm testornpm run lint. Fix bugs:npm run lint-fix. You can adjust your.eslintrcconfig file. - If you want to run transpilation to ES5 in
distfolder:npm run prepublish(standard npm hook).
Publishing as a node module
- Update version in package.json.
- Login as a npm user: run
npm login(Only required if not already logged in) - Compile the build: run
npm run prepublish - Publish the build: run
npm publish - In your parent application, just include this module as a dev dependency if it's not already included:
npm install aaa-header --save-devornpm update aaa-headerif it's already included in package.json
Also check out
License
MIT
