Prerequisites

• Node.js: v20
• Helm: Install via Homebrew

  brew install helm
  

• Ruby Gems: Install dependencies

  bundle install
  

• Cloudflare Tunnel: For development testing with GitHub

    cloudflared tunnel run <YOUR TUNNEL NAME>
  

• Docker: Run locally
• .env Configuration: Set environment variable

  APP_HOST=canine.example.com
  OMNIAUTH_GITHUB_WEBHOOK_SECRET=1234567890
  OMNIAUTH_GITHUB_PUBLIC_KEY=1234567890
  OMNIAUTH_GITHUB_PRIVATE_KEY=1234567890
  

• Enable git hooks:

  git config --local include.path .gitconfig
  

Running the app

Use the following command to start your application:

bin/dev

TODOs

• Onboarding flow (connect github)
• allow public network access flag is not currently doing anything
• Docker compose should work
• Allow connecting to github separately from the app, not just on sign up
• Make a single user mode
• I want a way to “stop” the processes, can maybe do this with a replicas=0 setting
• Rebulid metrics tabs so it works for both clusters & pods https://overcast.blog/zero-downtime-deployments-with-kubernetes-a-full-guide-71019397b924?gi=95ab85c45634
• Make the landing page better
• Stop using default namespace -- use canine-system.