Skip to content

Commit d034528

Browse files
docs: add Cursor Cloud specific setup instructions to AGENTS.md (#77)
Co-authored-by: Cursor Agent <cursoragent@cursor.com> Co-authored-by: Piotr Wodecki <PiotrWodecki@users.noreply.github.com>
1 parent c0df050 commit d034528

1 file changed

Lines changed: 10 additions & 0 deletions

File tree

AGENTS.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# examples
2+
3+
A collection of ~20 example apps demonstrating Fishjam SDKs, grouped under `mobile-react-native/`, `web-react/`, `web-ts/`, plus standalone demos (`deep-sea-stories`, `gemini-demo`, `moq-demo`, `translation-demo`).
4+
5+
## Cursor Cloud specific instructions
6+
7+
Node (via nvm) and Corepack are pre-installed. Each app is an independent project (mostly Yarn Berry; `fishjam-react-native-webrtc`-style apps may use npm) — install per app directory (`yarn install` / `npm install`) as needed.
8+
9+
- Validated across all 20 apps: dependency install succeeds, and the best available check per app passes — web apps via `yarn build`, TS libs via `yarn typecheck`, React Native apps via `yarn lint` (native iOS/Android builds are not possible headless). `mobile-react-native/common` is a shared library with no validation script.
10+
- The apps are demos that need a running Fishjam backend (and API keys, e.g. Gemini for `gemini-demo`) configured via each app's env to actually connect; build/typecheck/lint work standalone.

0 commit comments

Comments
 (0)