Skip to content

Installation

Prerequisites

  • Node.js: v20 (specified in .nvmrc)
  • pnpm: v9.0.0+
  • Wrangler CLI: Cloudflare's CLI tool

Clone Repository

bash
git clone https://github.com/lwzlwz/supershyft-os
cd supershyft-os

Install Dependencies

bash
# Use correct Node version
nvm use

# Install packages
pnpm install

Environment Setup

API Worker Configuration

Create apps/api-worker/.dev.vars:

bash
# Linear Integration (Optional)
LINEAR_API_KEY=your_linear_api_key
LINEAR_TEAM_ID=your_team_id
LINEAR_LABEL_BUG=label_id_for_bugs
LINEAR_LABEL_FEATURE=label_id_for_features

Frontend Configuration

The frontend proxies API requests automatically. No additional configuration needed for local development.

Database Setup

Initialize the local D1 database:

bash
# Run migrations
wrangler d1 migrations apply supershyft-os --local

# Verify tables
wrangler d1 execute supershyft-os --local --command="SELECT name FROM sqlite_master WHERE type='table'"

Verify Installation

bash
# Check Node version
node --version  # Should be v20.x.x

# Check pnpm
pnpm --version  # Should be 9.0.0+

# Check Wrangler
wrangler --version

Next Steps

Head over to Development to start the dev servers.

Built for Supershyft Capital