api

README

OpenSchool API

The API service of OpenSchool, powering the UI and sending messages to/from the message bus.

Development Prerequisites

You will need:

• Docker
• A Linux development environment
• An installation of Nix

Once you have those, you need to run:

mkdir -p $HOME/.config/nix
cat "experimental-features = nix-command flakes" >> $HOME/.config/nix/nix.conf

Running

Clone a copy of the repository, then drop into a development shell via the included flake.

nix develop

This process could take a while the first time, as it will be downloading copies of required development tooling.

Now, you can run the server software.

go run . serve

By default, it will be running on port 8080, bound only to the local interface.