About The Project

Osmosis is a decentralized protocol for exchanging cryptomaies based on Cosmos. This project provide the base UI component to Osmosis info.

Built With

• ReactJS
• TypeScript
• Tailwindcss

Getting Started

Prerequisites

No prerequisites is need except NPM or YARN.

Installation

1. Install packages

    yarn add @latouche/osmosis-info-ui

2. Run it

    yarn storybook

3. Import the styles in application on the root, like _app.tsx

    import "@latouche/osmosis-info-ui/dist/styles.css";
   ...

4. Use components

    import React from "react";
    import { Button } from "@latouche/osmosis-info-ui";
   
    export defaut function Component() {
   	return (
   		<div>
   			<Button>Hello</Button>
   		</div>
   	);
   }

Development

To get a local copy up and running follow these simple steps.

1. Clone the project

   git clone https://github.com/DLatouche/osmosis-info-ui.git

2. Install packages

    yarn

3. Start storybook

    yarn storybook

4. Create a new component with a story to display it

Git workflow

To organize git workflow git flow is used.

Branches

• main: It's the current version of package.
• develop: It's branch who is used to create news features and contains next features.
• feature/xxx: It's used to create new feature.
• release/xxx: It's the link between develop branch and main branch. It contains the next version of main website. It usually used for pre-production website for testing purpose.
• hotfix/xxx: It's used to quickly fix bugs on the main branch.