Skam Docs

Developer Onboarding

Get your local environment up and running in under 10 minutes.

1. Prerequisites

Ensure you have the following installed:

Node.jsv20+

JavaScript runtime

PNPMv9+

npm install -g pnpm

Docker DesktopLatest

Required for local Supabase

Supabase CLILatest

brew install supabase/tap/supabase

2. Environment Variables

cp .env.example .env.local

Note: Ask the lead developer for development API keys if you don't have access to the Supabase dashboard or Shopier credentials.

3. Database Setup (Supabase)

Start the local Supabase stack (make sure Docker is running):

Start local Supabase
supabase start
Generate TypeScript types (optional)
pnpm run build:types

4. Install & Run

pnpm install
pnpm dev

5. Port Map

ServicePortCommand
Web Storefront3000pnpm dev:web
Admin Dashboard3001pnpm dev:dashboard
Docs (Swagger)3002pnpm dev:docs
Discord Bot8787pnpm dev:discord
Telegram Bot8788pnpm dev:telegram

6. Next Steps

Now that your app is running locally, read these documents to understand the system: