Skip to content

docs: add AGENTS.md with Cursor Cloud specific setup instructions #77

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
PiotrWodecki wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

docs: add AGENTS.md with Cursor Cloud specific setup instructions #77

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
10 changes: 10 additions & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# examples

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`).

## Cursor Cloud specific instructions

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.

- 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.
- 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.