Skip to content

Commit eb6c917

Browse files
Add AGENTS.md with Cursor Cloud specific instructions
Co-authored-by: Ishaan Jaff <ishaan-jaff@users.noreply.github.com>
1 parent 4b380bc commit eb6c917

1 file changed

Lines changed: 31 additions & 0 deletions

File tree

AGENTS.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# AGENTS.md
2+
3+
## Cursor Cloud specific instructions
4+
5+
This is a **Svelte 4 + Vite 5 + TypeScript** client-side SPA (no backend). All data is fetched at runtime from public GitHub APIs.
6+
7+
### Running the dev server
8+
9+
```bash
10+
npm run dev
11+
```
12+
13+
The app runs on `http://localhost:5173` by default.
14+
15+
### Available scripts (see `package.json`)
16+
17+
| Command | Purpose |
18+
|---|---|
19+
| `npm run dev` | Start Vite dev server |
20+
| `npm run build` | Production build to `dist/` |
21+
| `npm run check` | Run `svelte-check` (TypeScript + Svelte diagnostics) |
22+
| `npm run format` | Run Prettier with `--write` |
23+
24+
### Known issues
25+
26+
- `npm run check` reports 9 pre-existing TypeScript errors (type-casting issues in `App.svelte`, `Providers.svelte`, `Main.svelte`). These do **not** block the build or dev server.
27+
- `npx prettier --check .` reports 10 files with formatting issues (pre-existing).
28+
29+
### Environment variables (optional)
30+
31+
- `VITE_MIXPANEL_TOKEN` — enables Mixpanel analytics. The app works fully without it.

0 commit comments

Comments
 (0)