Git: Version control system
- macOS:
```
brew install git
```
- Ubuntu:
```
sudo apt install git-all
```
- Windows: Try Git bash
Go: The main development language
(Optional, recommended) direnv: environment variable manager
Docker: Run the application locally
(Optional, recommended) Make: Automated scripts for local development
- macOS:
```
brew install make
```
- Ubuntu:
```
sudo apt-get install make
```
- Windows: Install chocolatey (from a PowerShell with admin privileges), then run:
```
choco install make
```

Mockery: Generates mocks for Go interfaces. Requires Go.

go install github.com/vektra/mockery/[email protected]

gotestsum: Pretty test output. Requires Go.
```
go install gotest.tools/gotestsum@latest
```

Installation

Ensure you have SSH configured on GitHub for your machine.

Make sure you are using git in SSH mode.

git config --global url.ssh://[email protected]/.insteadOf https://github.com/

Ensure the GOPRIVATE variable is set in your local terminal:

# You can skip this step if you have direnv configured.
export GOPRIVATE=github.com/in-rich/*

Install the project dependencies:

go mod download

Make sure Docker is running, and available as a command:

docker ps -a

✅ Congrats, you're ready to go!

Check your environment:

go version
# go version go1.23rc1 darwin/amd64
docker -v
# Docker version 24.0.7, build afdd53b
make -v
# GNU Make 3.81
echo $GOPRIVATE
# github.com/in-rich/*

Usage

Run the server:

make run

Run tests:

make test

For Windows Users

We recommend using a bash terminal emulator. One such example is Git bash.

You may also use WSL.

In both cases, make sure the dependencies you install are available under your bash environment. This is automatic for Git Bash, but might require a separate setup for WSL.