Skip to content

Commit 8504a04

Browse files
Add AGENTS.md with Cursor Cloud dev environment instructions (#1)
Co-authored-by: Cursor Agent <cursoragent@cursor.com> Co-authored-by: Jakub Doboš <kubo6472@users.noreply.github.com>
1 parent cdd2326 commit 8504a04

1 file changed

Lines changed: 30 additions & 0 deletions

File tree

AGENTS.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# AGENTS.md
2+
3+
## Cursor Cloud specific instructions
4+
5+
### What this repo is
6+
This repo (`pages`) is a collection of independent **static websites** (plain HTML/CSS + a few images). There is no build system, no package manager, no tests, and no lint config. Each top-level directory is a self-contained site:
7+
8+
- `tojemoc/` — deployed to Cloudflare Pages project `tjm-sk` (also has a `_redirects` file).
9+
- `jakubdobos/` — deployed to Cloudflare Pages project `jakubdobos-eu` (has `assets/`).
10+
- `nixies/` — deployed to Cloudflare Pages project `nixietubeclock-eu`.
11+
- `bluenation/`, `lanserver/` — additional static sites not wired into the deploy workflow.
12+
13+
### Deployment
14+
Deployment is automatic: pushing to `master` triggers `.github/workflows/main.yml`, which runs `wrangler pages deploy <dir>` for `tojemoc`, `jakubdobos`, and `nixies`. This requires the `CLOUDFLARE_API_TOKEN` and `CLOUDFLARE_ACCOUNT_ID` repo secrets. These are **not** needed for local development.
15+
16+
### Running a site locally (dev)
17+
Use Cloudflare Pages local dev (matches the deploy tooling and honors `_redirects`). `wrangler` is not installed globally; run it via `npx`:
18+
19+
```
20+
npx --yes wrangler pages dev <dir> --port <port> --ip 0.0.0.0
21+
```
22+
23+
Example: `npx --yes wrangler pages dev tojemoc --port 8788 --ip 0.0.0.0`, then open `http://localhost:8788/`. Run one command per site on distinct ports to serve several at once. A plain static server (e.g. `python3 -m http.server` from inside a site dir) also works but does not apply `_redirects`.
24+
25+
### Lint / test / build
26+
There is nothing to lint, test, or build — the "app" is static HTML served as-is. Do not add build/test tooling unless explicitly asked.
27+
28+
### Notes / gotchas
29+
- `npm install -g ...` fails in this environment (npm global prefix is `/`, not writable). Use `npx` instead of global installs.
30+
- There is no `package.json`; do not run `npm install` at the repo root (it has nothing to install).

0 commit comments

Comments
 (0)