Skip to main content

Introduction

PATH
Path API & Toolkit Harness

Grove logo

Static Badge GitHub Actions Workflow Status GitHub last commit GitHub go.mod Go version GitHub Release GitHub Downloads (all assets, all releases) GitHub Issues or Pull Requests GitHub Issues or Pull Requests GitHub Issues or Pull Requests App Status

PATH (Path API & Toolkit Harness) is an open source framework for enabling access to a decentralized supply network. It provides various tools and libraries to streamline the integration and interaction with decentralized protocols.

Table of Contents

Path Releases

PATH releases provide a Docker image to quickly bootstrap your Path gateway without building your own image.

Resources

docker pull ghcr.io/buildwithgrove/path

Where to start?

If you're unsure of where to start, we recommend the following:

  1. Environment Setup: Prepare your environment for running PATH
  2. Shannon Cheat Sheet: Get up and running with a Gateway to Shannon
  3. Configs: Explore other PATH configuration files
  4. Walkthrough: A step-by-step guide of local PATH configurations and running tests
  5. Morse Cheat Sheet: Get up and running with a Gateway to Morse if you're feeling adventurous

Special Thanks

The origins of this repository were inspired by the work kicked off in gateway-server by the Nodies team. We were inspired and heavily considering forking and building off of that effort.

However, after a week-long sprint, the team deemed that starting from scratch was the better path forward for multiple reasons. These include but are not limited to:

  • Enabling multi-protocol support; Morse, Shanon and beyond
  • Set a foundation to migrate Grove's quality of service and data pipelineta
  • Integrating with web2 standards like Envoy, gRPC, Stripe, NATS, Auth0, etc...
  • Etc...

License

This project is licensed under the MIT License; see the LICENSE file for details.