@open-web3/api-mobx

MobX integration for polkadot.js

Usage no npm install needed!

<script type="module">
  import openWeb3ApiMobx from 'https://cdn.skypack.dev/@open-web3/api-mobx';
</script>

README

@open-web3 JS library

This monorepo contains all the Javascript packages provided by Open Web3 Stack.

Packages Overview

Development

To start off, this repo uses yarn workspaces to organise the code. As such, after cloning, its dependencies should be installed via yarn, not via npm; the latter will result in broken dependencies.

To get started

  1. Clone the repo locally, via git clone https://github.com/open-web3-stack/open-web3.js.git
  2. Ensure that you have a recent version of Node.js, for development purposes Node 10 is recommended.
  3. Ensure that you have a recent version of Yarn, for development purposes Yarn >=1.10.1 is required.
  4. Install the dependencies by running yarn install
  5. Build the everything via yarn run build
  6. Run all test cases via yarn jest
  7. Run lint via yarn lint