JavaScript client for Core Auctions

A Umi-compatible JavaScript library for the project.

Getting started

1. First, if you're not already using Umi, follow these instructions to install the Umi framework.
2. Next, install this library using the package manager of your choice.

   npm install core-auctions

3. Finally, register the library with your Umi instance like so.

   import { coreAuctions } from 'core-auctions';
   umi.use(coreAuctions());

You can learn more about this library's API by reading its generated TypeDoc documentation.

Setting up Benchmarks

The GitHub workflow will automatically run benchmarks on pushes to the main branch, however it needs a gh-pages branch to deploy the hosted graph website to. Run the commands below to setup the gh-pages branch.

git checkout --orphan gh-pages
git reset --hard
git commit --allow-empty -m "Initializing gh-pages branch"
git push origin gh-pages
git checkout master

Afterwards, the webpage will be available at https://<GITHUB_ORG_OR_USERNAME>.github.io/<REPO_NAME>/dev/bench/

Contributing

Check out the Contributing Guide the learn more about how to contribute to this library.