Skip to content

Add Cursor Cloud specific development environment instructions #49

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
Simplereally wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Add Cursor Cloud specific development environment instructions #49

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 38 additions & 1 deletion AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,4 +95,41 @@ Add: `bun add <pkg>`
## Styling (shadcn/ui + Tailwind)
- Use shadcn/ui as the base; extend via composition + variants.
- Tailwind utilities in JSX; extract repetition into components, not `@apply`.
- Theme via CSS variables; keep design tokens centralized.
- Theme via CSS variables; keep design tokens centralized.

---

## Cursor Cloud specific instructions

### Product overview
Bloom Studio is a SaaS AI image/video generation app built with Next.js 16 (App Router, Turbopack), Convex (backend + real-time DB), Clerk (auth), and the Pollinations.AI API.

### Services

| Service | How to run | Notes |
|---------|-----------|-------|
| **Next.js dev server** | `bun run dev` | Starts on port 3000 by default |
| **Convex backend** | `bunx convex dev` | Requires a Convex project + `CONVEX_DEPLOYMENT` env var |

### Environment variables
The app requires a `.env.local` file at the repo root with at minimum:
- `NEXT_PUBLIC_CONVEX_URL` — Convex deployment URL (hard error if missing)
- `NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY` — Clerk publishable key
- `CLERK_SECRET_KEY` — Clerk server-side secret key (Clerk middleware rejects requests without this)
- `NEXT_PUBLIC_APP_URL` — defaults to `http://localhost:3000`

Without valid Clerk keys the dev server compiles successfully but all page requests return 500. Clerk middleware (`proxy.ts`, which is loaded as the Next.js middleware) validates keys server-side.

### Key commands
- **Lint:** `bun run lint` (ESLint flat config, caches to `.cache/eslint`)
- **Test:** `bun run test` (Vitest + jsdom + React Testing Library; 205 test files, ~2800 tests)
- **Type-check:** `bun run typecheck`
- **Dev:** `bun run dev`

### Gotchas
- The middleware file is `proxy.ts` (not the standard `middleware.ts`). Clerk's `@clerk/nextjs` package auto-discovers it.
- Do **not** use `bun test` directly — always use `bun run test` (there's a guard script for this).
- `.env*` files are gitignored; you must create `.env.local` yourself.
- After changing `.env.local`, you must restart the dev server for the changes to take effect.
- The `convex/_generated/` directory is gitignored and created by `bunx convex dev`; Convex functions won't type-check until it exists.
- Never run `bun run build`, `bun run lint`, and `bun run test` in parallel — they can conflict.
Loading