Before reading this doc, make sure you've read through our CONTRIBUTING guide.

This is not an in depth guide for setting up all dependencies, but it should give you a starting point.

Prerequisites:

• All prerequisites in the CONTRIBUTING guide
• Install ASDF and all plugins/tools from .tool-version in the top level of the Firezone repo
• Install pnpm

From the top level director of the Firezone repo start the Postgres container:

docker compose up -d postgres

Inside the /elixir directory run the following commands:

# Install dependencies
# --------------------
> mix deps.get

# Generate dev cert, install npm packages and build assets
# ---------------------------------------------------------
> mix phx.gen.cert
> mix setup

# Setup and seed the DB
# ---------------------
> mix ecto.seed

# Start the portal:
# ------------------
> iex -S mix

The web and API endpoints should now be running:

• Web -> https://localhost:13443/
• API -> ws://localhost:13001/

Prerequisites:

• Stripe account
• Stripe CLI

Steps:

• Reset and seed the database (seeds use static IDs that correspond to staging setup on Stripe):

  mix do ecto.reset, ecto.seed
  

• Start Stripe CLI webhook proxy:

  stripe listen --forward-to localhost:13001/integrations/stripe/webhooks
  

• Start the Phoenix server with enabled billing from the elixir/ folder using a test mode token:

  cd elixir/
  BILLING_ENABLED=true STRIPE_SECRET_KEY="...copy from stripe dashboard..." STRIPE_WEBHOOK_SIGNING_SECRET="...copy from stripe cli tool.." mix phx.server
  

When updating the billing plan in stripe, use the Stripe Testing Docs for how to add test payment info