Add Cursor Cloud specific development environment instructions#49
Add Cursor Cloud specific development environment instructions#49Simplereally wants to merge 1 commit intomainfrom
Conversation
- Document required services (Next.js dev server, Convex backend) - Document required environment variables for .env.local - Document key commands (lint, test, typecheck, dev) - Document gotchas (proxy.ts middleware, bun test guard, env restart) Co-authored-by: Simplereally <[email protected]>
|
The latest updates on your projects. Learn more about Vercel for GitHub. 1 Skipped Deployment
|
|
Important Review skippedDraft detected. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
✨ Finishing Touches🧪 Generate unit tests (beta)
📝 Coding Plan
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment Tip CodeRabbit can use your project's `biome` configuration to improve the quality of JS/TS/CSS/JSON code reviews.Add a configuration file to your project to customize how CodeRabbit runs |
Reviewer's GuideAdds a new 'Cursor Cloud specific instructions' section to AGENTS.md that documents how to set up and run the Bloom Studio dev environment (services, env vars, commands, and common gotchas) when working in Cursor Cloud. Flow diagram for Bloom Studio dev environment setup and gotchas in Cursor Cloudflowchart TD
Start["Start in Cursor Cloud workspace"] --> CloneRepo["Open/clone Bloom Studio repo"]
CloneRepo --> CreateEnv["Create .env.local at repo root"]
subgraph EnvVars["Populate .env.local"]
Env1["Set NEXT_PUBLIC_CONVEX_URL"]
Env2["Set NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY"]
Env3["Set CLERK_SECRET_KEY"]
Env4["Optionally set NEXT_PUBLIC_APP_URL (default http://localhost:3000)"]
end
CreateEnv --> Env1
Env1 --> Env2 --> Env3 --> Env4
Env4 --> StartConvex["Run bunx convex dev (generates convex/_generated/)"]
StartConvex --> StartNext["Run bun run dev (Next.js dev server)"]
StartNext --> CheckError["Visit app URL in browser"]
CheckError --> NoError["Pages load without 500 errors"]
CheckError --> HasError["Pages return 500 from Clerk middleware"]
HasError --> FixEnv["Fix Clerk keys in .env.local"]
FixEnv --> RestartDev["Restart dev server after env change"]
RestartDev --> CheckError
NoError --> DevLoop["Development loop: bun run lint, bun run test, bun run typecheck"]
subgraph Gotchas["Gotchas"]
G1["Middleware file is proxy.ts, auto-discovered by @clerk/nextjs"]
G2["Do not run bun test directly, use bun run test"]
G3[".env* files are gitignored; must create .env.local manually"]
G4["Convex types require convex/_generated/ from bunx convex dev"]
end
StartNext -. reference .-> G1
DevLoop -. reference .-> G2
CreateEnv -. reference .-> G3
StartConvex -. reference .-> G4
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
Summary
Adds Cursor Cloud specific development environment instructions to
AGENTS.mdto help future cloud agents set up and run the development environment correctly.Changes
## Cursor Cloud specific instructionssection toAGENTS.mdwith:.env.localVerification
bun run test)bun run lint)bun run dev) — compilation works; page serving requires valid Clerk credentialsSummary by Sourcery
Documentation: