Skip to content

Latest commit

 

History

History
88 lines (57 loc) · 2.91 KB

README.template.md

File metadata and controls

88 lines (57 loc) · 2.91 KB
Raw

TODO_REPO_NAME

Demo repo for TODO_REPO_DESCRIPTION.

To follow along, please read the accompanying tutorial at docs.hedera.com (WIP).

⚠️ NOTE that this repo is still a work in progress, and is therefore incomplete. Sections are explicitly marked (WIP) as markers/ reminders.

How to run

You may choose to run this demo repo and follow along the tutorial, either: (a) on your own computer (recommended for experienced developers), or (b) using Gitpod (recommended for quick/ easy setup).

How to run on your computer

To run on your own computer, git clone this repo, and follow the instructions in the "pre-requisites" section of the accompanying tutorial.

  1. Install all the prerequisite software
  2. Run ./util/00-main.sh and this script will interactively prompt you, and populate the values needed in the .env file
  3. Run ./util/03-get-dependencies.sh and this script will install the required dependencies
  4. Run ./util/04-rpcrelay-run.sh and this script will run a Hedera JSON-RPC Relay instance
    • Note that this requires docker to be available on your system
    • Note that you may delay performing this step until later, you only need it for HSCS related sequences
  5. Congratulations, you can now move on to the sequences! 🎉

How to run using Gitpod

To run on Gitpod (a cloud development environment), click the button below:

  1. Wait for Gitpod to load, this should take less than 10 seconds
  2. In the VS code terminal, you should see 3 terminals, get_deps, rpcrelay_run, and main
  3. You do not need to use the get_deps and rpcrelay_run terminals, simply let them run in the background
  4. In the main terminal, which is the one that displays by default, a script will interactively prompt you
  5. Congratulations, you can now move on to the sequences! 🎉

Sequences

This repo contains the code required for TODO_REPO_SEQUENCES_SUMMARY_DESC. The following sections outline what each sequence will cover.

TODO_REPO_SEQUENCES_FULL_DESC.

TODO_SEQUENCE_X_NAME

What you will accomplish:

  1. TODO_SEQUENCE_X_ACCOMPLISH

Steps:

  1. TODO_SEQUENCE_X_STEPS

TODOs

  • TODO_ITEMS_TODO

Author

Brendan Graetz

Licence

MIT