Jamboree26 Scoutnet Cache

This server acts as a middleman between applications and Scoutnet. It:

• Reformats responses from Scoutnet to make them easier to work with. For example, it makes HUB sections appear as real groups.
• Provides an OpenAPI document on /openapi for better type safety (also available at https://scouterna.github.io/j26-scoutnet-cache/openapi.json).
• Provides human-readable API documentation on /docs (also available at https://scouterna.github.io/j26-scoutnet-cache).
• Caches responses to easen the burden on Scoutnet.

It does not have any form of authorization built in. If a system can access the server, they can access all data. This is subject to change.

Running

For every commit on main we build a Docker image, tagged with the short hash of the commit. We also publish the latest tag. You'll find the image here.

# Copy and fill out the .env file
cp .env.example .env

# Run the cache server, making sure to expose port 80
docker run --env-file .env -p 8080:80 ghcr.io/scouterna/j26-scoutnet-cache

Developing

Before getting started, make sure you have pnpm installed.

Setting up your development environment is as easy as creating a .env file and installing the dependencies.

# Copy and fill out the .env file
cp .env.example .env

# Install dependencies
pnpm install

The run the development server:

pnpm run dev

A Bruno collection is available to be opened in the bruno directory. Please make sure to update this collection when making changes to the application.

If you're using VS Code you'll be prompted to install the Biome extension. When installed, restart VS Code to have linter errors show up in your IDE.