mohammedpatla/osmosis-info-front

Osmosis Analytics Interface

Osmosis - Info

An analytics interface for Osmosis AMM.
View Demo

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Git workflow
   • Branches

About The Project

Osmosis is a decentralized protocol for exchanging cryptomaies based on Cosmos. This project allow to display and make accessible all the information relating to Osmosis.

Built With

• ReactJS
• Material UI
• Tradingview
• Osmosis API

Getting Started

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

Prerequisites

No prerequisites is need except NPM or YARN.

Installation

1. Install packages

    yarn

   or

   npm install

2. Run it

    yarn start

   or

   npm run start

Git workflow

To organize git workflow git flow is used.

Branches

• main: It's the current version of production web site.
• 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.
• theme/xxx: It's just to save theme. Themes are developped in feature/xxx first, after being pushed in production, they are placed in theme/xxx branch.