Development Guide

This guide is intended to help you get started with running the application locally, and making changes to it.

Prerequisites

• Go 1.22.0 or higher
• Node.js version 20.10.0 or higher
• Docker
• Redis is used as the datastore and for pubsub
• A text editor, preferably VS Code, and a CLI

INFO

The Go app runs as a single binary with the frontend embedded inside it

Running locally

The easiest way to run locally is by using Docker.

Build Vue frontend

The Vue frontend must be built first

cd ./src/frontend/
npm install
npm run build-dev

This installs the packages, dependencies, and creates assets in frontend/dist directory. This directory is embedded in the backend Golang binary when it is built.

Run with Docker

Navigate back to root directory and run -

docker compose up

This builds and starts a docker container for the app, and another container with Redis.
The app starts at http://localhost:8080

Setting up for Development

Ensure you have Redis running.

TIP

From the previous docker step, you can keep the Redis container running and stop the other containers

Running Go backend app

To run the Go app directly (outside the container) - Open a terminal and from the root directory

cd ./src/
go run .

This starts the Go server. You are ready to make changes to the Go app now.

TIP

Go must be installed for this step.

Running Vue frontend app

Open another terminal and from the root directoy -

cd ./src/frontend/
npm run dev

This starts the Vue app at http://localhost:5173
Feel free to make changes to the app.