Skip to content

Latest commit

 

History

History
36 lines (27 loc) · 1.03 KB

HACKING.md

File metadata and controls

36 lines (27 loc) · 1.03 KB

Hacking on Tunl

Prerequisites

Before you start, make sure you have the following installed on your system:

  1. Rust (including cargo)
  2. Wrangler
  3. Node.js (Wrangler requires Node.js)

Setting Up the Development Environment

Start by getting the code:

$ git clone https://github.com/bepass-org/tunl.git && cd tunl

Install the dependencies:

$ rustup update
$ npm install wrangler --save-dev

Create an API token from the cloudflare dashboard.

Create a .env file based on .env.example and fill the values based on your tokens:

$ cp .env.example .env
$ sed -i 's/test/YOUR_CF_API_TOKEN/g' .env

Run the local server and start hacking:

$ make dev

NOTE: If your changes modify the configuration file, ensure you run make schema before submitting your patch.