Development Environment

If you want to have a nice Lago Development Environment, you can follow this guide on how to make it works on your machine.

NOTE: This documentation is intended for people willing to contribute to Lago. If you want to try Lago on your local system, we encourage your to look at the Lago public documentation.

Requirements

• Git
• Docker
  • Docker for Ubuntu
  • Docker Desktop for MacOS
• Homebrew (macOS only)

  /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"

• OpenSSL

  # Ubuntu/Debian
  sudo apt update
  sudo apt install openssl
  
  # MAC OS
  brew install openssl

Local Environment Setup

• First of all, you need to clone the Lago repo on your machine, since we're using Git submodules, here is the good command to do it

git clone --recurse-submodules git@github.com:getlago/lago.git
cd lago

# If you're not using bash, replace .bashrc with your shell rc, ei: ~/.zshrc
echo "export LAGO_PATH=${PWD}" >> ~/.bashrc
echo 'alias lago="docker-compose -f $LAGO_PATH/docker-compose.dev.yml"' >> ~/.bashrc
source ~/.bashrc

• Install mkcert and generate some certs for TLS usage

brew install mkcert nss
mkcert -install
cd $LAGO_PATH/traefik
mkdir certs
cd certs
mkcert -cert-file lago.dev.pem -key-file lago.dev-key.pem lago.dev "*.lago.dev"

• Add all custom domains to your /etc/hosts file

127.0.0.1 traefik.lago.dev
127.0.0.1 api.lago.dev
127.0.0.1 app.lago.dev
127.0.0.1 pdf.lago.dev
127.0.0.1 license.lago.dev
127.0.0.1 mail.lago.dev

• Setup API

cp ./api/.env.dist ./api/.env
touch ./api/config/master.key

Local Environment Commands

• Start your local environment

lago up -d db redis traefik mailhog clickhouse
lago up front api api-worker api-clock pdf

• Start enjoying your local Lago at https://app.lago.dev

• Start the Rails console with lago exec api bin/rails console

Seeding your DB

To ensure your own user is created when starting the app, define the following vars to your ./api/.env file:

LAGO_CREATE_ORG=true
LAGO_ORG_USER_EMAIL=your-email@example.com
LAGO_ORG_USER_PASSWORD=password
LAGO_ORG_NAME=Acme
LAGO_ORG_API_KEY=<THE GENERATED LICENSE KEY> # Use the license server guide to generate the key.

If you want to execute all the seeders in ./api/db/seeders/ run lago exec api bin/rails db:seed

Setup license service

Follow instructions at https://github.com/getlago/lago-license

Update your local copy of the code

git pull --recurse-submodules