Rocket-UI

Rocket UI Components Collection

A set of reusable and composable React components built on top of Material UI core for developing fast and friendly web applications interfaces.

Installation

You first need to install @totalsoft/rocket-ui the package

npm install @totalsoft/rocket-ui

Then you can use anything you need from the library.

import { IconButton } from '@totalsoft/rocket-ui'

Contributing guide

This library uses Yarn 2 Plug'n'Play, see its documentation in order to install it locally.

When using Visual Studio Code please follow these steps: Editor Setup for VSCode (allows VSCode to read .zip yarn cache files and supports features like go-to-definition).

- Build

yarn install
yarn build

- Test

yarn test

- Testing the build and package creation locally

First create the build, the result will be located in the dist folder

yarn run build

Then, generate the npm package locally. It will generate a .tgz file, this is basically a compressed copy of a target directory. You can install this with npm i ./file.tgz or just open it in explorer.

npm pack

- Testing local packages

To test the package locally without publishing to a npm repository, you can create a link in your testing project. For example:

npm link <YOUR_PATH>\rocket-ui-ts

If the package reference does not already exist in your testing project, you can add it without specifying the version:

{
  "dependencies": {
    ...
    "@totalsoft/rocket-ui": "",
  }
}

For additional options see the official documentation

Running Storybook locally

This project's documentation is written using Storybook.

To start it locally run the following command in your terminal: yarn storybook

Or use the existing Storybook Debug VSCode launch configuration, to start it in debug mode.

License

rocket-ui-ts is licensed under the MIT license. @TotalSoft