Getting Started

Prerequisites

Setup

  1. Install the prerequisites above.
  2. cd into the repository.
  3. Run direnv allow — direnv will automatically enter the nix develop shell that contains all the tools you need to build and run the project.
  4. Run git config core.hooksPath .githooks to enable the repo's git hooks (dev lint on commit, dev test -short ./... on push). Bypass with --no-verify when needed.

Every new terminal opened in the repository will automatically provide the correct environment.

Project layout

Path Description
cmd/ Binary entry points (controller, router, fixture, dev)
docs/content/ Documentation site source (Markdown)
internal/ Skipper source code (Go)
internal/web/ Web UI server, handlers, and HTML templates
nix/ Nix development environment
tmp/ Temporary build artifacts (safe to delete)
template.yaml.erb Krane deployment template