README.md

This repo contains starter code to boot up a Dharma Relayer.

• FAQ
  • What is Dharma?
  • What is a Dharma relayer?
  • Why start a Dharma relayer?
  • What is the approval process for becoming a Dharma Relayer?
  • What technical skills are required to operate a Dharma Relayer?
  • Do I need to conform to any specific branding when launching a Dharma relayer?
• What's included?
• Getting Started
  • Clone
  • Dependencies
  • Blockchain
  • Backend
  • Frontend
• Running on Kovan
  • Backend
  • Frontend
• Deployment
  • Create a new Heroku app:
  • Set which network you want to deploy to:
  • Overwrite the app's files with your relayer kit:
  • Open your new relayer on Heroku:

FAQ

What is Dharma?

Dharma is an open, permissionless protocol that enables anyone to engage in credit-based transactions on the Ethereum blockchain. Read more here.

What is a Dharma relayer?

A relayer is a source of liquidity on the Dharma network. It connects borrowers with lenders.

You can think of it as a bulletin board where individuals connected on the Internet can post requests to borrow money.

Why start a Dharma relayer?

We imagine a world in which the majority of financial transactions occur on globally accessible blockchains.

In this new world, being a relayer is akin to an early internet entrepreneur, providing a valuable service on the frontiers of the new economy.

What is the approval process for becoming a Dharma Relayer?

There is no approval process for launching a Dharma Relayer. You can launch whenever you want. Dharma is live on the Ethereum mainnet.

What technical skills are required to operate a Dharma Relayer?

Nothing outside of the traditional web stack. The only programming language necessary is JavaScript.

Do I need to conform to any specific branding when launching a Dharma relayer?

No, we intentionally created this starter kit without branding so that you, the entrepreneur, can conceive of and implement your own brand.

We imagine there being many relayers — each differentiated by the market they serve and the brand they build.

What's included?

The Relayer Starter Kit is packed with features that allow you to focus on your business.

• Extensible React app
• Unstyled components that can be easily branded
• Local blockchain with the Dharma smart contracts pre-loaded
• Kovan and mainnet ready
• Deployable to Heroku out of the box

Ideas? Feedback? We want to hear from you! Email us at mailto:[email protected].

Getting Started

We made getting started fast, simple and fun. No fiddling with blockchains required.

Clone

Clone the repo to your workstation:

git clone https://github.com/dharmaprotocol/relayer-starter-kit.git

Dependencies

To run the project, you'll first need to install the dependencies:

yarn

Blockchain

And launch a local blockchain via:

yarn blockchain

Backend

And launch the server via:

yarn server

Frontend

And launch the React frontend via:

yarn start

Running on Kovan

There is no need for running a local blockchain in this state.

Backend

And launch the server via:

`yarn kovan-server`

Frontend

And launch the React frontend via:

`yarn start-kovan`

Deployment

Everything you need to deploy to Heroku is baked into this repo.

In your command line, make sure you're logged into heroku, and then enter the following commands:

Create a new Heroku app:

heroku create

Set which network you want to deploy to:

heroku config:set NETWORK=kovan

Overwrite the app's files with your relayer kit:

git push -f heroku master

Open your new relayer on Heroku:

heroku open