botting-os

Botting OS - Unified Operations Dashboard

A modern dashboard for managing bots, proxies, accounts, and orders in one place.

Features (MVP)

🚀 Live Demo

Frontend Demo: https://marcusinthewarehouse.github.io/botting-os/

Deployed automatically on every merge to main via GitHub Pages.

Quick Start

Local Development

Backend Setup

cd backend
npm install
npx prisma migrate dev
npm run dev

Backend runs at http://localhost:3001

Frontend Setup (Phase 2+)

cd frontend
npm install
npm run dev

Frontend runs at http://localhost:3000

Development Workflow

  1. Clone the repo
    git clone https://github.com/marcusinthewarehouse/botting-os.git
    cd botting-os
    
  2. Create a feature branch
    git checkout -b feature/your-feature-name
    
  3. Make changes and commit
    git add .
    git commit -m "feat: description of changes"
    
  4. Push and open a PR
    git push origin feature/your-feature-name
    
  5. PR Checks
    • GitHub Actions runs CI pipeline automatically
    • Tests must pass before merge
    • Changes are reviewed
  6. Merge to main
    • After approval, merge your PR to main
    • CI pipeline runs
    • If successful, frontend automatically deploys to GitHub Pages

Testing

Run Backend Tests

cd backend
npm test

Run Frontend Tests (Phase 2+)

cd frontend
npm test

CI/CD Pipeline

Tests run automatically on:

Status is reported in PR checks.

Deployment

Automatic Deployment

Manual Deployment (if needed)

# Trigger deployment manually
# Go to Actions tab → "Deploy to GitHub Pages" → "Run workflow"

Documentation

Team

Status

Last deployment: Check Actions for latest status