Skip to content

Setup

Install the following tools before getting started:

Run this once after cloning the repo:

git config core.hooksPath .githooks

This activates the pre-commit hook which:

  • Runs type-checking on backend changes before every commit
  • Keeps env-dev.sha256 / env-prod.sha256 in sync when env files change

The following files are not committed to git. Get them from Bitwarden and place them at the paths below:

FilePathBitwardenGitHub Secret
Dev env varsgrowl-backend/terraform/.env.devENV_FILE_DEV_B64 (base64-encoded)
Prod env varsgrowl-backend/terraform/.env.prodENV_FILE_PROD_B64 (base64-encoded)
EC2 SSH key~/.ssh/growl-key (or wherever you prefer)EC2_SSH_KEY

Tfvars files are committed to git and do not need to be retrieved separately.

To encode an env file for storing as a GitHub secret:

cat growl-backend/terraform/.env.dev | base64

The local server reads from growl-backend/.env. Get the dev env file from Bitwarden and place it at growl-backend/.env.

Then start the server:

cd growl-backend
make local-server