KaustubhShamshery / apidocs

JSON RPC Documentation for Zilliqa

Zilliqa JSON-RPC API documentation. Powered by Slate.

Overview

Zilliqa apidocs contains the documentation of all JSON-RPC methods used to interact with Zilliqa nodes in order to transact and deploy/call contracts. You may currently find support for:

• cURL
• JavaScript via zilliqa-js
• Java via laksa-j
• Ruby via laksa-ruby

Contributing to Zilliqa apidocs

Prerequisites

You're going to need the following to contribute:

• Linux or macOS — Windows may work, but is unsupported.
• Ruby, version 2.3.1 or newer
• Bundler — If Ruby is already installed, but the bundle command doesn't work, just run gem install bundler in a terminal.

Running apidocs locally

1. Fork this repository on GitHub.

2. Clone your forked repository (not our original one) to your hard drive with

   git clone https://github.com/Zilliqa/apidocs.git && cd apidocs

3. Initialize and start Slate. You can either do this locally, or with Vagrant:

   # either run this to run locally
   bundle install
   bundle exec middleman server
   
   # OR run this to run with vagrant
   vagrant up

You can now see the docs at http://localhost:4567.

Contributing guidelines

• Learn more about editing Slate markdown HERE.
• Please adhere to the Code of Conduct when participating in the Zilliqa community.
• Please utilise the PR template when submitting Pull Requests to this repository.