Initial setup

On this page you will find an information about prerequisites and necessary tools that you need to setup for development

Tooling installation

Working with HUMAN Protocol codebase and running its oracles requires to have some common tooling installed:

• git - to work with the repo

• openssl - to generate keys for JWT-based auth

• gpg tools - to generate keys for encyption

Then the set of tools may differ based on way you want to interact with services. In case you want to run some specific setup (e.g. Running HUMAN Protocol with CVAT) - install Docker (v23+) & Docker Compose. In case you want to run services using native tools or want to do development, you will need:

• for JS-based apps:

  • nvm

  • Node@^18.20.x

  • yarn

• for Python-based apps

  • python3

  • poetry

and in order to run some app you can follow steps in its README.md file and check this documentation for hints.

---

Git branches

After you finished the installation and verified tools are working (e.g. by running version command for them), you can start getting familiar with the codebase.

Public monorepo with HUMAN Protocol codebase can be found on GitHub: https://github.com/humanprotocol/human-protocol

Repository uses develop branch as a default one, but production version is in main branch, so checkout to the version you need.