one-weir-ver16 v1.0.4

one-weir

One UI for One Weir

Documentation

Thanks for using the one-weir component library. More information about how we work can be found on our documentation site

Install

1. Create a new Personal Access Token (https://github.com/settings/tokens). SAVE THE TOKEN!
2. Open a terminal
3. Run npm install https://[YOUR PERSONAL ACCESS TOKEN]:x-oauth-basic@github.com/weirgroup/one-weir.git#dist

To develop one-weir while developing another application

To make changes to one-weir while you are developing another app, you need to run npm link and link your local dev directories. After you run these steps, whenever you make a change to one-weir, your app will also reload. Be sure to make a PR to submit your one-weir changes!

1. Open a terminal
2. Clone one-weir to a directory
3. Change directory to one-weir
4. Run npm install
5. Run npm link
6. Run npm run start - One-Weir is now running and listening for any changes to one-weir code
7. Change directory to the application directory
8. Run npm link one-weir
9. Start your application. Now the application will use one-weir source directory instead of the packaged distribution.

IMPORTANT: Before you check in code - remove your Personal access token from package.json

1. Open package.json
2. Find one-weir
3. Replace git+https://[YOUR PERSONAL ACCESS TOKEN]:x-oauth-basic@github.com/weirgroup/one-weir.git#dist with git+ssh://git@github.com/weirgroup/one-weir.git#dist

Usage

import * as React from 'react'

import MyComponent from 'one-weir'

class Example extends React.Component {
  render () {
    return (
      <MyComponent />
    )
  }
}

License

MIT © Dirk-tooth