setup.md

Prerequisites for Local Development

This repository should work on Linux and Mac.

You will need:

• docker (install) You can use Docker Engine on Linux.
• docker compose (V2) (install)
• transcrypt (install)
• inv (install)

Optional for Local Development

• ngrok (install)

  For testing inbound emails.

Getting Started

If you are using Windows ensure that git is setup to use LF not CLRF

git config core.autocrlf false
git rm --cached -r .
git reset --hard

Environment variables are stored in .env files and encrypted using transcrypt. You can list all encrypted files with transcrypt --list.

To intialise the repository on cloning, run:

transcrypt -c aes-256-cbc -p $TRANSCRYPT_PASSWORD

The transcrypt password is available in the Tech team Bitwarden account.

Next, build the Docker environment that we'll be using:

# Build Webpack container
inv build -w
# Build Django container
inv build

You can set up your database with the reset command:

inv reset

Create a user for local development and testing using your Anika email address:

inv superuser [email protected]

Finally you can bring up the web server:

inv dev

You should now be able to access:

• The Anika website at http://localhost:8000.
• The Clerk CMS at http://localhost:8000/clerk.
• The Django Admin Interface at http://localhost:8000/admin.

You can list other available commands using the --list argument of the invoke command:

inv -l