Development setup

To set up your development environment, install Git, Make, PlantUML, and a Go compiler, e.g.:

sudo apt install git golang make plantuml

Then install the linting tools:

go install golang.org/x/vuln/cmd/govulncheck@latest
go install honnef.co/go/tools/cmd/staticcheck@latest

Clone the source code:

git clone https://git.sr.ht/~javiljoen/doxyte
cd doxyte

Run make check to verify that everything is set up correctly.

Set up Git hooks:

echo "make check check-vulns" > .git/hooks/pre-push
chmod +x .git/hooks/pre-push

To run the development server via make serve, you will also need Python 3 (which is probably already installed on your system).

If you are me, you will also need hut in order to publish the docs.