https://github.com/osmosis-labs/osmosis-info-front

Osmosis Analytics Interface
https://github.com/osmosis-labs/osmosis-info-front

Last synced: about 2 months ago
JSON representation

Osmosis Analytics Interface

• Host: GitHub
• URL: https://github.com/osmosis-labs/osmosis-info-front
• Owner: osmosis-labs
• Created: 2021-08-15T19:11:14.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-05-17T19:39:30.000Z (8 months ago)
• Last Synced: 2024-05-18T15:49:30.270Z (8 months ago)
• Language: HTML
• Size: 24 MB
• Stars: 32
• Watchers: 13
• Forks: 23
• Open Issues: 14
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        






  

    

  

  
Osmosis - Info


  


    An analytics interface for Osmosis AMM.

    


    View Demo

  


  
Table of Contents

  


    


      About The Project

      


        
Built With

      

    

    


      Getting Started

      


        
Prerequisites

        
Installation

      

    

      


      Git workflow

      


        
Branches

      

      

  


## About The Project

[![Screenshot](./screenshot.png)](https://osmosis.imperator.co/)

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](https://reactjs.org/)

- [Material UI](https://material-ui.com/)

- [Tradingview](https://www.tradingview.com/)

- [Osmosis API](https://api-osmosis.imperator.co/swagger/)

## 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

   ```sh

    yarn

   ```

   or

   ```sh

   npm install

   ```

2. Run it

   ```sh

    yarn start

   ```

   or

   ```sh

   npm run start

   ```

## Git workflow

To organize git workflow [git flow](http://danielkummer.github.io/git-flow-cheatsheet/) 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.