Develop Guide

How to install, test and contribute

Installation

To install the project, run the following script from the root of your project's directory:

$ npm install

Configuration

Create a file `.env` with the following structure:

LOTUS_HOST="<your lotus rpc host>"
LOTUS_TOKEN="<your token>"

Running test

To run the test of the project, run the following script from the root of your project's directory:

$ npm run test

Getting involved

All contributions to this project will be released under the MIT public domain dedication. By submitting a pull request or filing a bug, issue, or feature request, you are agreeing to comply with this waiver of copyright interest.

There are two primary ways to help:

• Using the issue tracker, and.

• Changing the code-base.

Using the issue tracker

Use the issue tracker to suggest feature requests, report bugs, and ask questions. This is also a great way to connect with the developers of the project as well as others who are interested in this solution.

Use the issue tracker to find ways to contribute. Find a bug or a feature, mention in the issue that you will take on that effort, then follow the Changing the code-base guidance below.

Changing the code-base

Generally speaking, you should fork this repository, make changes in your own fork, and then submit a pull request. All new code should have associated unit tests that validate implemented features and the presence or lack of defects. Additionally, the code should follow any stylistic and architectural guidelines prescribed by the project. In the absence of such guidelines, mimic the styles and patterns in the existing code-base.