github/sim
1
0
Fork 0
mirror of https://github.com/simstudioai/sim.git synced 2026-02-09 22:25:33 -05:00
Code Issues Packages Projects Releases Wiki Activity

docs: add .cursor/CLOUD.md with development guide for cloud agents

Browse Source 
Co-authored-by: Vikhyath Mondreti <icecrasher321@users.noreply.github.com>
This commit is contained in:
Cursor Agent
2026-02-09 21:29:29 +00:00
parent 8361b74d7e
commit 9694dbd4f9
1 changed files with 34 additions and 29 deletions
Download Patch File Download Diff File Expand all files Collapse all files

63
.cursor/CLOUD.md
View File

@@ -1,40 +1,45 @@
# Sim Studio - Cloud Agent Guide
# Sim Studio - Cloud Agent Development Guide
## Overview
Sim Studio is a monorepo (Turborepo + Bun workspaces) for building and deploying AI agent workflows. See `CLAUDE.md` for architecture, coding conventions, and integration guides. See `.github/CONTRIBUTING.md` for contributor workflows.
Sim Studio is a monorepo for building and deploying AI agent workflows. See `CLAUDE.md` and `README.md` for architecture, coding standards, and integration guidelines.
## Services
| Service | Port | Command |
|---------|------|---------|
| Next.js App (sim) | 3000 | `bun run dev` (from root) |
| Realtime Socket Server | 3002 | `bun run dev:sockets` (from root) |
| Both together | 3000 + 3002 | `bun run dev:full` (from root) |
| Docs (Fumadocs) | 3001 | `cd apps/docs && bun run dev` |
| PostgreSQL (pgvector) | 5432 | Docker container `simstudio-db` |
| Service | Command | Port | Notes |
|---------|---------|------|-------|
| Next.js app | `bun run dev` (from root) | 3000 | Main application |
| Socket.IO realtime | `bun run dev:sockets` (from `apps/sim`) | 3002 | Collaborative editing |
| Both together | `bun run dev:full` (from `apps/sim` or root) | 3000, 3002 | Recommended for development |
| Docs | `bun run dev` (from `apps/docs`) | 3001 | Optional documentation site |
| PostgreSQL + pgvector | Docker container | 5432 | Required database |
## Key Commands (run from repo root)
## Key Commands
| Task | Command |
|------|---------|
| Lint (check only) | `bun run lint:check` |
| Lint (auto-fix) | `bun run lint` |
| Format (check) | `bun run format:check` |
| Format (auto-fix) | `bun run format` |
| Tests | `bun run test` |
| Type check | `bun run type-check` |
| Dev (full) | `bun run dev:full` |
| DB migrations | `cd packages/db && bunx drizzle-kit migrate --config=./drizzle.config.ts` |
- **Lint**: `bun run lint:check` (biome check, no auto-fix) or `bun run lint` (with auto-fix)
- **Format**: `bun run format:check` or `bun run format` (with auto-fix)
- **Test**: `bun run test` (runs vitest via turbo across packages)
- **Type-check**: `bun run type-check` (runs tsc --noEmit via turbo)
- **Dev**: `bun run dev:full` from root or `apps/sim` (starts Next.js + Socket.IO)
## Database
- PostgreSQL with pgvector extension, connection via `DATABASE_URL` in `.env` files
- Migrations: `cd packages/db && bunx drizzle-kit migrate --config=./drizzle.config.ts`
- Schema push (no migration files): `cd packages/db && bunx drizzle-kit push --config=./drizzle.config.ts`
- Two `.env` files are needed: `apps/sim/.env` and `packages/db/.env` (both need `DATABASE_URL`)
## Testing
- Framework: Vitest (config at `apps/sim/vitest.config.ts`)
- Use `@sim/testing` mocks/factories (see `.cursor/rules/sim-testing.mdc`)
- Tests run in parallel with thread pool
- Run specific test: `cd apps/sim && bunx vitest run path/to/test.test.ts`
## Important Notes
- **Package manager**: Always use `bun` / `bunx`, never `npm` / `npx`.
- **Linter**: Biome (not ESLint). Config at `/workspace/biome.json`.
- **Testing**: Vitest. Test files co-located as `*.test.ts`. Use `@sim/testing` mocks.
- **Pre-commit**: Husky runs `bunx lint-staged` which runs `biome check --write`.
- **Database**: PostgreSQL 17 with pgvector extension. Drizzle ORM for schema/migrations.
- **Env files**: `apps/sim/.env` and `packages/db/.env` must both have `DATABASE_URL`.
- **Docs type-check**: Requires `fumadocs-mdx` to be run first (generates `.source/` directory). This runs as `postinstall` in `apps/docs`.
- **Redis**: Optional. Socket server falls back to in-memory mode without `REDIS_URL`.
- **Auth**: Better Auth. Social providers (GitHub, Google) need `clientId`/`clientSecret` in env. Warnings about missing social provider config are expected in dev.
- Package manager is **bun** (not npm/pnpm). Use `bun` and `bunx` commands.
- The docs app requires `fumadocs-mdx` generation before type-check: `cd apps/docs && bunx fumadocs-mdx`
- Pre-commit hook runs `bunx lint-staged` which applies biome check with auto-fix
- Social provider warnings (GitHub/Google missing clientId) during startup are expected in local dev
- Redis warnings ("REDIS_URL not configured") are expected - app runs in single-pod mode locally