Merge pull request #1 from coreui/nwb

v2.0.0-alpha with nwb

.gitignore

@@ -1,6 +1,22 @@
+# See https://help.github.com/ignore-files/ for more about ignoring files.
+
+# dependencies
+/node_modules
+package-lock.json
+
+# testing
+/demo/dist
+
+# testing
+/coverage
+
+# production
+/es
+/lib
+/umd
+
+# misc
 .DS_Store
 .idea
-package-lock.json
 
-# Folders to ignore
-node_modules
+npm-debug.log*

.travis.yml

@@ -0,0 +1,16 @@
+sudo: false
+
+language: node_js
+node_js:
+  - 8
+
+before_install:
+  - npm install codecov.io coveralls
+
+after_success:
+  - cat ./coverage/lcov.info | ./node_modules/codecov.io/bin/codecov.io.js
+  - cat ./coverage/lcov.info | ./node_modules/coveralls/bin/coveralls.js
+
+branches:
+  only:
+    - master

CONTRIBUTING.md

@@ -0,0 +1,25 @@
+## Prerequisites
+
+[Node.js](http://nodejs.org/) >= v4 must be installed.
+
+## Installation
+
+- Running `npm install` in the component's root directory will install everything you need for development.
+
+## Demo Development Server
+
+- `npm start` will run a development server with the component's demo app at [http://localhost:3000](http://localhost:3000) with hot module reloading.
+
+## Running Tests
+
+- `npm test` will run the tests once.
+
+- `npm run test:coverage` will run the tests and produce a coverage report in `coverage/`.
+
+- `npm run test:watch` will run the tests on every change.
+
+## Building
+
+- `npm run build` will build the component for publishing to npm and also bundle the demo app.
+
+- `npm run clean` will delete built resources.

README.md

@@ -1 +1,34 @@
-# @coreui/react `v2.0.0-alpha`
+## @coreui/react v2
+
+[![Travis][build-badge]][build]
+[![npm package][npm-badge]][npm]
+[![Coveralls][coveralls-badge]][coveralls]
+
+_@coreui/react v2_ :construction:
+- work in progress :warning: 
+- bootstrapped with [nwb](https://github.com/insin/nwb) toolkit
+
+[build-badge]: https://img.shields.io/travis/user/repo/master.png?style=flat-square
+[build]: https://travis-ci.org/user/repo
+
+[npm-badge]: https://img.shields.io/npm/v/@coreui/react.png?style=flat-square
+[npm]: https://www.npmjs.com/package/@coreui/react
+
+[coveralls-badge]: https://img.shields.io/coveralls/user/repo/master.png?style=flat-square
+[coveralls]: https://coveralls.io/github/user/repo
+
+#### `npm run` scripts
+
+`package.json` is configured with `"scripts"` we can use with `npm run` while developing the project.
+
+Command | Description |
+--- | ---
+`npm start` | start a development server for the demo app
+`npm test` | run tests
+`npm run test:coverage` | run tests and produce a code coverage report in `coverage/`
+`npm run test:watch` | start a test server and re-run tests on every change
+`npm run build` | prepare for publishing to npm
+`npm run clean` | delete built resources
+
+#### see also:
+- [Developing React Components and Libraries with nwb](https://github.com/insin/nwb/blob/master/docs/guides/ReactComponents.md#developing-react-components-and-libraries-with-nwb)