firezone/CONTRIBUTING.md

Contributing Guide

Read this guide before opening a pull request.

Table of Contents

1. Prerequisites
2. Project Setup
   1. Provision the test VMs
   2. Start the WireGuard interface on the server
   3. Start the WireGuard interface on the client
3. Testing TBD

Prerequisites

You'll need the following software installed to develop for FireZone:

• Vagrant
• Ansible
• VirtualBox
• asdf VM
• A recent version of PostgreSQL server installed and running
• dotenv functionality for your shell

Project Setup

1. Ensure Postgres is running with a superuser role of firezone. E.g.

$ psql -h localhost -d postgres

> CREATE ROLE firezone;

2. Install the language versions defined in .tool-versions:

# Run this from the project root
$ asdf install

3. Resolve dependencies

$ mix deps.get
$ npm install --prefix apps/fz_http/assets

4. Bootstrap DB

$ mix ecto.setup

5. Launch Server

mix phx.server

Testing

Run tests with mix test from the project root.