@rocket.chat/onboarding-ui
v0.34.0
Published
Set of components and functions for the onboarding experience on Rocket.Chat
Downloads
3,308
Maintainers
Keywords
Readme
@rocket.chat/onboarding-ui
Set of components and functions for the onboarding experience on Rocket.Chat
Install
Firstly, install the peer dependencies (prerequisites):
npm i @rocket.chat/fuselage @rocket.chat/fuselage-hooks @rocket.chat/fuselage-polyfills @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/fuselage-polyfills @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:
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.
Building
As this package dependends on others in this monorepo, before anything run the following at the root directory:
yarn build
Linting
To ensure the source is matching our coding style, we perform linting. Before commiting, check if your code fits our style by running:
yarn lint
Some linter warnings and errors can be automatically fixed:
yarn lint-and-fix
Running tests
Whenever possible, add tests to describe exactly what your code do. You can run them by yourself:
yarn test