Skip to content

Quick Start

Sergi edited this page Nov 6, 2026 · 1 revision

Use code of this repository with caution.

Prerequisites

• Node.js 18+ installed. • A GitHub OAuth Application configured for your local development.

Installation

  1. Clone the repository:
git clone https://github.com/Logic-HQ/OctoTriage.git
// or
git clone git@github.com:Logic-HQ/OctoTriage.git
cd octotriage
  1. Configure environment variables:
    • Required app secrets: GITHUB_CLIENT_ID, GITHUB_CLIENT_SECRET
cp .dot_env .env

Open .env and fill in your GitHub Client ID and your serverless token-exchange proxy URL.

  1. Install dependencies:
npm install -g pnpm
pnpm approve-builds esbuild
  1. Build
pnpm run build

Run & Operate

- `pnpm --filter @workspace/api-server run dev` — run the API server (port 5000)
- `pnpm --filter @workspace/octotriage run dev` — run the OctoTriage web app (port 3001)
- `pnpm run typecheck` — full typecheck across all packages
- `pnpm run build` — typecheck + build all packages
- `pnpm --filter @workspace/api-spec run codegen` — regenerate API hooks and Zod schemas from the OpenAPI spec
- `pnpm --filter @workspace/db run push` — push DB schema changes (dev only)

Launch development server:

This work in progress.

It considered to be as:

npm run dev

Clone this wiki locally