Skip to content

Latest commit

 

History

History
26 lines (15 loc) · 1.24 KB

DEVELOPMENT_GUIDE.md

File metadata and controls

26 lines (15 loc) · 1.24 KB
Raw

Development Guide

Running a development version

Fork the repository and clone it to your local environment (see contributing guideleines.

To compile and run the package locally, you need to run the following command in place of mailchain command found in the docs: go run cmd/mailchain/main.go + COMMAND e.g. serve, account list etc..

Examples

To serve your development version

  1. Navigate into the directory of the repository
  2. Run: go run cmd/mailchain/main.go serve

To add account using to your development version

  1. Navigate into the directory of the repository
  2. Run: go run cmd/mailchain/main.go account add --protocol=ethereum --key-type="secp256k1" --private-key=YOUR_PRIVATE_KEY

Inbox vs Inbox Staging

From time to time, there may be pending breaking changes that have not been released. This means that if you use the web inbox, it may not work as desired.

We track this and patch the https://inbox-staging.mailchain.xyz to address these teething issues. If you think something may be broken using the regular inbox, try this. If still broken, please raise an issue.