Skip to main content

Getting Started

Welcome to the SMO1 Cat Colony! This guide will help you set up your development environment.

Prerequisites

  • Go 1.24+ (for backend services)
  • Node.js 20+ with pnpm (for frontend services)
  • Docker (for local development dependencies)
  • Terraform 1.7+ (for infrastructure management)

Quick Start

1. Clone the repositories

# Core services
git clone https://github.com/smo1-io/purr-api.git
git clone https://github.com/smo1-io/meow-web.git
git clone https://github.com/smo1-io/zoomies-edge.git

# Supporting
git clone https://github.com/smo1-io/litter-box.git
git clone https://github.com/smo1-io/catnip-packages.git

2. Start infrastructure

cd litter-box
docker-compose up -d
This starts PostgreSQL, Redis, ClickHouse, Prometheus, and Grafana locally.

3. Start the API

cd purr-api
cp .env.example .env
make run

4. Start the dashboard

cd meow-web
cp .env.example .env.local
pnpm install
pnpm dev

Environments

NamePurposeAlias
kittenDevelopmentdevelopment
catStagingstaging
lionProductionproduction

Next Steps