Skip to content

chore: set up Cursor Cloud dev environment #23

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

chore: set up Cursor Cloud dev environment #23

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

## Cursor Cloud specific instructions

This repo is the static GitHub Pages site for the **CardputerZero AppStore Hub** (app catalog web UI + generated registry JSON), a bundled **VitePress developer docs** site, and a browser-based **WASM emulator**. There is no backend, database, or Docker in this repo. See `README.md` and `developer-docs/dev/repositories.md` for the broader ecosystem (device OS, packages repo, on-device store) which lives in other repos.

### Services and how to run them (dev mode)

- **Hub SPA + emulator (main product):** vanilla HTML/CSS/JS served statically from the repo root. Run `python3 -m http.server 4173` from `/workspace`, then open `http://localhost:4173/`. Note: README says `cd hub` first, but in this checkout the site root is the repo root (`index.html` is at the top level) — do NOT `cd hub`, there is no `hub/` dir.
- App catalog: `http://localhost:4173/#/apps` (loads `generated/registry.json`, currently 25 apps).
- Emulator: `http://localhost:4173/emulator/`.
- Must be served over HTTP (not `file://`) because the SPA uses `fetch()` for the registry and Markdown docs.
- **VitePress developer docs:** npm project under `developer-docs/`. Run `npm run dev` (default port 5173, browse at `http://localhost:5173/docs/` because `base: '/docs/'`). `npm run build` outputs to `developer-docs/.vitepress/dist/`; the committed production build lives in top-level `docs/`.

### Lint / test / build

- No linter, no automated test suite, and no root package manager in this repo.
- The only CI build check is VitePress: `.github/workflows/docs-check.yml` runs `npm install` + `npm run build` inside `developer-docs/` (Node 20 in CI; the VM has a newer Node which also works).
- `scripts/generate_registry.py` regenerates `generated/registry.json` from upstream Debian package metadata. It uses only the Python standard library (no pip deps) but needs network access to `CardputerZero/packages`; it is a maintainer/CI task, not needed for local browsing.