@remote.it/components

@remote.it/components

Install

npm i @remote.it/components

Usage

import { Button } from '@remote.it/components'

function MyComponent(): JSX.Element {
  return (
    <div>
      <Button>Click me!</Button>
    </div>
  )
}

Development

Setup the project:

# Use the right version of node
nvm use

# Install dependencies
npm i

You need to add the fontawesome token to your config: npm config set '//npm.fontawesome.com/:_authToken' ""

Useful commands:

• Link Desktop: npm run link-desktop to run the necessary commands to sym-link the components into the desktop app for rapid development. Then npm link back to this component from desktop npm link ../../remote.it.js/packages/remoteit-components/
• Test: npm run verify or watch with npm run test-watch
• Build: npm run compile (from the project root)
• Run Storybook: npm run storybook
• Version: npm run version
• Publish: npm run release
• Publish alpha: npm run alpha-release
• You must be a member of the @remote.it npm organization, have Two-Factor auth setup and have been granted access to this project before you can publish.

License

MIT

Contributing

PRs welcome! Please write tests, update docs and run ESLint on your changes (see package.json for scripts to help).