Getting Started

Setup

Install, configure, migrate, and run Urmate and the documentation app.

Setup

This page explains local setup for both the Urmate app and this documentation app.

Requirements

Node.js 20+ recommended for Urmate. The documentation app uses Node 22 successfully.
npm for Urmate.
pnpm 11+ for the documentation workspace.
PostgreSQL for Urmate DATABASE_URL.
Optional Redis for real-time/socket-backed features.
Optional MySQL/PHP service for the full Circles bridge.
External provider accounts only for features you test: Google OAuth/Calendar, GitHub OAuth, Telegram/Discord/Meta, Stripe/Razorpay/PayPal, CloudNest, XRouter providers, E2B, CodeSandbox, Daytona.

Urmate App

Install packages

cd /root/apps/urmate
npm install

Configure environment

cp .env.example .env.local

At minimum, configure:

DATABASE_URL="postgresql://user:password@127.0.0.1:5432/urmate?schema=public"
BETTER_AUTH_URL="http://localhost:3000"
BETTER_AUTH_TRUSTED_ORIGINS="http://localhost:3000"
BETTER_AUTH_SECRET="generate-a-long-random-auth-secret"
NEXT_PUBLIC_SITE_URL="http://localhost:3000"
CHAT_CHANNEL_PUBLIC_ORIGIN="http://localhost:3000"
LLM_PROVIDER_SECRET_KEY="generate-a-long-random-secret"
LLM_PROVIDER_DIGEST_KEY="generate-a-different-long-random-secret"

Prepare database

For normal development:

npm run db:migrate

For disposable local sync:

npm run db:push

Run development server

npm run dev

If you need the socket server:

npm run dev:all

Urmate Documentation App

cd /root/apps/docus
pnpm install
pnpm run dev

Documentation content lives in:

/root/apps/docus/docs/content/en

Useful Urmate Scripts

Script	Purpose
`npm run dev`	Start Next.js.
`npm run dev:all`	Start Next.js and socket server.
`npm run dev:socket`	Start only Socket.IO server.
`npm run dev:full`	Integrated dev flow with game engine script.
`npm run dev:game-engine`	Game engine dev flow.
`npm run vps:relay`	Start VPS relay.
`npm run build`	Build Next.js app.
`npm run start`	Start production build.
`npm run lint`	ESLint.
`npm run db:migrate`	Prisma migrate dev.
`npm run db:push`	Prisma schema push.

Smoke Test

After setup:

Open /auth/login.
Login/register.
Open /dashboard.
Open /dashboard/study.
Open /dashboard/chat.
Open /dashboard/xrouter.
Check terminal for auth, DB, or provider errors.

Edit this pageorReport an issue

Project Overview

A high-level map of Urmate modules, technology stack, and workspace structure.

Environment

Important Urmate environment variables grouped by feature area.