@metamorph-ui/react v0.0.3

Metamorph UI

A lightweight collection of reusable components library for React JS.

• Documentation: metamorph-ui.surge.sh
• NPM: @metamorph-ui/react

Installation

To use Metamorph UI components, all you need to do is install the @metamorph-ui/react package :

# Using NPM
$ npm i @metamorph-ui/react styled-components

# Using Yarn
$ yarn add @metamorph-ui/react styled-components

Usage

To start using components, please follow these steps :

1. Wrap your application with the MetamorphProvider provided by @metamorph-ui/react.

import { MetamorphProvider } from "@metamorph-ui/react";

// Do this at the root of your application
function App({ children }) {
  return <MetamorphProvider>{children}</MetamorphProvider>;
}

2. And you can start using components.

import { Button } from "@metamorph-ui/react";

function Example() {
  return <Button title="Hello World!">;
}

Development

Before starting, you need to have Git and Node installed.

# Clone project
$ git clone https://github.com/dirgaprksha/metamorph-ui.git

# Access repository
$ cd metamorph-ui

# Install dependencies
$ yarn install

# Run project
$ yarn run start

Another script options :

1. yarn install to install all dependencies.
2. yarn run clean to clean all node_modules and dist packages.
3. yarn run clean:dist to clean all dist packages.
4. yarn run build to generate all packages to cjs, esm and umd format.
5. yarn run start to run project.
6. yarn run doc to start storybook documentation (server will initialize in http://localhost:6006).
7. yarn run doc:build to build storybook documentation.
8. yarn run test to test unit and snapshot testing all packages.
9. yarn run test:watch to test unit and snapshot testing all packages (watching).

License

This project is under license from MIT. For more details, see the LICENSE file.

Maintainer

• Dirga Prakesha (@dirgaprksha) – UI/UX Frontend Engineer