Code Monkey home page Code Monkey logo

osmosis-toolkit's Introduction

Osmosis Toolkit

Osmosis Toolkit Logo

A lite, easy to use toolkit for interacting with the Osmosis Blockchain. The first of many projects spearheaded by the Osmosis Support Lab, a community funded organization for the Osmosis community.

Features

Feature Status
Swaps Status: Coming Soon
Joining/Exiting Pools Status: Coming Soon
Bonding/Unbonding from Pools Status: Coming Soon

Run the toolkit locally

The below steps are what one would need to do to either contribute, or run a local version.


  1. Clone and fork the Github repo.
git clone https://github.com/osmosis-support-lab/osmosis-toolkit

cd osmosis-toolkit

git fetch upstream

git checkout dev

  1. Install all dependencies.
yarn

You can down run a local copy of the Osmosis tool kit! Simply run:

yarn dev

This will automatically create a "hot-refresh" build in which you can make changes to the code, save the file, and see the change live! Or, if you simply want to utilize a local copy.

For those wishing to contribute please read along.


Contributing

Contributions are always welcome! See contributing.md for ways to get started. Please adhere to this project's code of conduct.

If you followed the above steps to get a local copy up and running, congratulations! You're halfway there!


Git Flow

This repo follows the git flow model of repositories. For in-depth information please visit the contributing guide.

  • New Feature:
    • Start: git flow feature start <name>
    • End: git flow feature finish <name>
    • Publish: git flow feature publish <name>
  • Bugfixes:
    • Start: git flow bugfix start <name>
    • End: git flow bugfix finish <name>
    • Publish: git flow bugfix publish <name>

Things to do every time you publish

We are asking all contributors to ensure that all files are linted, and formatted. Before a release build is created, the repo maintainers also perform these steps as a back up, but the less errors at build time, the better!

To Lint:

yarn lint

To Format:

yarn format

Resources used

Frameworks/UI Builders

Blockchain Integrations

License

MIT

osmosis-toolkit's People

Contributors

toggletek avatar

Stargazers

 avatar  avatar

Watchers

 avatar

Forkers

jasbanza

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.