Getting Started
Local setup for the Olgax Community Platform monorepo
Prerequisites
- Node.js 20+, pnpm 9+, Docker (for local PostgreSQL)
Install & configure
pnpm install
docker compose up -d # starts Postgres on localhost:5434
cp .env.example packages/database/.env
cp .env.example apps/web/.env.localFill in apps/web/.env.local:
BETTER_AUTH_SECRET— any random string (e.g.openssl rand -base64 32)GITHUB_CLIENT_ID/GITHUB_CLIENT_SECRET— from a GitHub OAuth App with callback URLhttp://localhost:3000/api/auth/callback/githubGITHUB_SYNC_TOKEN— optional personal access token, used server-side to sync tracked projects (works unauthenticated too, at a much lower GitHub rate limit)
Migrate & seed
pnpm --filter @olgax/database run migrate
pnpm --filter @olgax/database run db:seed # seeds data-driven badges + missionsTrack a project
pnpm --filter @olgax/github run add-project -- --owner=OLGAX-com --repo=olgax-pos [email protected]Run
pnpm dev # apps/web on :3000
pnpm dev:docs # this docs site on :3001Managing accounts
The first sign-in via GitHub auto-creates a User + Profile row with the default
CONTRIBUTOR role.
pnpm --filter @olgax/database run users # list users
pnpm --filter @olgax/database run promote -- [email protected] # -> ADMINISTRATOR