Skip to content

Commit bf6a175

Browse files
authored
Merge pull request #1 from coreui/nwb
v2.0.0-alpha with nwb
2 parents 2ee038d + 91b3b70 commit bf6a175

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

79 files changed

+26095
-18739
lines changed

.babelrc

-7
This file was deleted.

.eslintrc.js

-68
This file was deleted.

.gitignore

+19-3
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,22 @@
1+
# See https://help.github.com/ignore-files/ for more about ignoring files.
2+
3+
# dependencies
4+
/node_modules
5+
package-lock.json
6+
7+
# testing
8+
/demo/dist
9+
10+
# testing
11+
/coverage
12+
13+
# production
14+
/es
15+
/lib
16+
/umd
17+
18+
# misc
119
.DS_Store
220
.idea
3-
package-lock.json
421

5-
# Folders to ignore
6-
node_modules
22+
npm-debug.log*

.travis.yml

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
sudo: false
2+
3+
language: node_js
4+
node_js:
5+
- 8
6+
7+
before_install:
8+
- npm install codecov.io coveralls
9+
10+
after_success:
11+
- cat ./coverage/lcov.info | ./node_modules/codecov.io/bin/codecov.io.js
12+
- cat ./coverage/lcov.info | ./node_modules/coveralls/bin/coveralls.js
13+
14+
branches:
15+
only:
16+
- master

CONTRIBUTING.md

+25
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
## Prerequisites
2+
3+
[Node.js](http://nodejs.org/) >= v4 must be installed.
4+
5+
## Installation
6+
7+
- Running `npm install` in the component's root directory will install everything you need for development.
8+
9+
## Demo Development Server
10+
11+
- `npm start` will run a development server with the component's demo app at [http://localhost:3000](http://localhost:3000) with hot module reloading.
12+
13+
## Running Tests
14+
15+
- `npm test` will run the tests once.
16+
17+
- `npm run test:coverage` will run the tests and produce a coverage report in `coverage/`.
18+
19+
- `npm run test:watch` will run the tests on every change.
20+
21+
## Building
22+
23+
- `npm run build` will build the component for publishing to npm and also bundle the demo app.
24+
25+
- `npm run clean` will delete built resources.

README.md

+34-1
Original file line numberDiff line numberDiff line change
@@ -1 +1,34 @@
1-
# @coreui/react `v2.0.0-alpha`
1+
## @coreui/react v2
2+
3+
[![Travis][build-badge]][build]
4+
[![npm package][npm-badge]][npm]
5+
[![Coveralls][coveralls-badge]][coveralls]
6+
7+
_@coreui/react v2_ :construction:
8+
- work in progress :warning:
9+
- bootstrapped with [nwb](https://github.com/insin/nwb) toolkit
10+
11+
[build-badge]: https://img.shields.io/travis/user/repo/master.png?style=flat-square
12+
[build]: https://travis-ci.org/user/repo
13+
14+
[npm-badge]: https://img.shields.io/npm/v/@coreui/react.png?style=flat-square
15+
[npm]: https://www.npmjs.com/package/@coreui/react
16+
17+
[coveralls-badge]: https://img.shields.io/coveralls/user/repo/master.png?style=flat-square
18+
[coveralls]: https://coveralls.io/github/user/repo
19+
20+
#### `npm run` scripts
21+
22+
`package.json` is configured with `"scripts"` we can use with `npm run` while developing the project.
23+
24+
Command | Description |
25+
--- | ---
26+
`npm start` | start a development server for the demo app
27+
`npm test` | run tests
28+
`npm run test:coverage` | run tests and produce a code coverage report in `coverage/`
29+
`npm run test:watch` | start a test server and re-run tests on every change
30+
`npm run build` | prepare for publishing to npm
31+
`npm run clean` | delete built resources
32+
33+
#### see also:
34+
- [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)

0 commit comments

Comments
 (0)