https://github.com/bnhovde/rui-components

Simple React UI components
https://github.com/bnhovde/rui-components

Last synced: 13 days ago
JSON representation

Simple React UI components

• Host: GitHub
• URL: https://github.com/bnhovde/rui-components
• Owner: bnhovde
• License: mit
• Created: 2017-03-06T11:33:07.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2017-03-20T12:51:35.000Z (almost 8 years ago)
• Last Synced: 2024-11-28T01:37:30.882Z (29 days ago)
• Language: JavaScript
• Homepage: https://bnhovde.github.io/rui-components/#/
• Size: 3.04 MB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![build status](https://secure.travis-ci.org/bnhovde/rui-components.svg)](http://travis-ci.org/bnhovde/rui-components) [![bitHound Score](https://www.bithound.io/github/bnhovde/rui-components/badges/score.svg)](https://www.bithound.io/github/bnhovde/rui-components) [![Dependency Status](https://david-dm.org/bnhovde/rui-components.svg)](https://david-dm.org/bnhovde/rui-components)

# Simple React UI components

### NB: Not yet functional

## Basic Usage

test

### Common Tasks

* Developing - **npm start** - Runs the development server at *localhost:8080* and use Hot Module Replacement. You can override the default host and port through env (`HOST`, `PORT`).

* Creating a version - **npm version ** - Updates */dist* and *package.json* with the new version and create a version tag to Git.

* Publishing a version - **npm publish** - Pushes a new version to npm and updates the project site.

### Testing

The test setup is based on Jest. Code coverage report is generated to `coverage/`. The coverage information is also uploaded to codecov.io after a successful Travis build.

* Running tests once - **npm test**

* Running tests continuously - **npm run test:watch**

* Running individual tests - **npm test -- ** - Works with `test:watch` too.

* Linting - **npm run test:lint** - Runs ESLint.

### Documentation Site

The boilerplate includes a [GitHub Pages](https://pages.github.com/) specific portion for setting up a documentation site for the component. The main commands handle with the details for you. Sometimes you might want to generate and deploy it by hand, or just investigate the generated bundle.

* Building - **npm run gh-pages** - Builds the documentation into `./gh-pages` directory.

* Deploying - **npm run deploy-gh-pages** - Deploys the contents of `./gh-pages` to the `gh-pages` branch. GitHub will pick this up automatically. Your site will be available through *.github.io/`.

* Generating stats - **npm run stats** - Generates stats that can be passed to [webpack analyse tool](https://webpack.github.io/analyse/). This is useful for investigating what the build consists of.

## Highlighting Demo for the Site

```js

var a = 5;

var b = 10;

// just trying out code highlighting feature here

console.log(a + b);

```

## Credits

npm boilerplate used: [https://github.com/survivejs/react-component-boilerplate](https://github.com/survivejs/react-component-boilerplate)