Skip to content

Quickstart

The project relies on local Kubernetes with Kind and Skaffold for iterative development.

  • Docker
  • kubectl
  • kind
  • skaffold
  • helm
  1. Create a local Kubernetes cluster with the provided registry config:
    Terminal window
    kind create cluster --config kind-config.yaml
  2. Add convenient development domains to /etc/hosts (requires sudo):
    Terminal window
    sudo deployment/scripts/dev-domains.sh add
  3. Add Helm repositories and update them:
    Terminal window
    ./deployment/scripts/add-helm-repos.sh
  4. Create the required namespaces:
    Terminal window
    ./deployment/scripts/create-namespaces.sh
  5. Start Skaffold in dev mode to build and deploy the services:
    Terminal window
    skaffold dev

When Skaffold completes, the FastAPI app is reachable at https://api.localdev.me.


This project is under active development; interfaces and infrastructure may change.