CI/CD Lecture template project

A simple checklist implemented in Golang with an angular frontend.

One day it will be a modern replacement for strichliste.org maybe. Maybe check out their demo real quick to get a quick overview of the aimed feature set.

How to create your own repo

# clone the original repo
git clone https://github.com/rubenhoenle/template.git

# create your github repo, set it to public, then get its (preferred ssh) clone url
git remote set-url origin git@github.com:yourusername/reponame.git
# then just push, that's it
git push

Usage

The app will run on port 8080.

Development

Prerequisites

You should have installed the following tools on your system for development.

• Golang (version 1.23.4)
• NodeJS (version 22 LTS)
• Trivy
• if possible: Docker (or if you know what you're doing you might also choose Podman).

For the users of the nix package manager among us, there is also a ´flake.nix´ provided which contains a devshell with all needed packages.

Building the application

The backend provides a REST API which lets you create, update, delete, ... users, articles and transactions. The backend

# building the frontend
cd frontend
npm ci
npx ng build
# copy the angular build result so it can be embedded by the go backend
cp -r frontend/dist/frontend/browser backend/cmd/strichliste/frontendDist

# running the application (e.g. for development)
cd backend
go run ./cmd/strichliste/main.go 
# you should be able to access the frontend of the app the app on http://localhost:8080 now in your browser
# the rest api should be accessible on http://localhost/api now

# building a binary for distribution
cd backend
CGO_ENABLED=0 go build -o ./strichliste ./cmd/strichliste/main.go

Further information

If you want to get started with the REST API, please check out the bruno collection which is part of the repository.

And here some further instructions which might be helpful for you during development:

# running all the backend tests
cd backend
go run ./...

# creating a test coverage report for the backend
cd backend
go test ./... -coverprofile=coverage.out && go tool cover -html=coverage.out -o coverage.html

Code format

FYI: gofmt should already be available on your system if you have go installed.

# apply code format
gofmt -w ./backend
cd frontend; npx prettier --write .

# check code format
# FYI: this will print the list of files which are not formatted correctly
gofmt -l ./backend
cd frontend; npx prettier --check .

# check code format in CI pipeline
# FYI: the go fmt command does not end with exit code 1, instead prints only the list of files which are not formatted correctly. 
# So here's how to get a exit code 1 in case the format is not correct.
files=$(gofmt -l ./backend) && [ -z "$files" ]