@rocket.chat/onboarding-ui

> Set of components and functions for the onboarding experience on Rocket.Chat

---

  !react version  !npm downloads !License: MIT

!deps !npm bundle size

Install

Firstly, install the peer dependencies (prerequisites):

``sh
npm i @rocket.chat/fuselage @rocket.chat/fuselage-hooks @rocket.chat/icons @rocket.chat/layout @rocket.chat/logo @rocket.chat/styled react react-dom react-i18next

or, if you are using yarn:

yarn add @rocket.chat/fuselage @rocket.chat/fuselage-hooks @rocket.chat/icons @rocket.chat/layout @rocket.chat/logo @rocket.chat/styled react react-dom react-i18next
`

Add @rocket.chat/onboarding-ui as a dependency:

`sh
npm i @rocket.chat/onboarding-ui

or, if you are using yarn:

yarn add @rocket.chat/onboarding-ui
`

Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues.

$3

As this package dependends on others in this monorepo, before anything run the following at the root directory:

`sh
yarn build
`

$3

To ensure the source is matching our coding style, we perform linting>).
Before commiting, check if your code fits our style by running:

`sh
yarn lint
`

Some linter warnings and errors can be automatically fixed:

`sh
yarn lint-and-fix
`

$3

Whenever possible, add tests to describe exactly what your code do. You can run them by yourself:

`sh
yarn test
``