Skip to content

Development environment setup #1

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

Open
jaypov99 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Development environment setup #1

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 @@
## Cursor Cloud specific instructions

This is **wt-tracker**, a high-performance WebTorrent tracker (WebRTC signaling server). Single Node.js process, no external services (no DB, no Redis, no Docker).

### Key commands

All commands are in `package.json` scripts. Highlights:

- `npm run lint` — ESLint
- `npx vitest run` — run tests (use `run` to avoid watch mode)
- `npm run build` — lint + clean + compile TypeScript to `lib/`
- `npm start -- [config.json]` — start server (requires build first)

### Notes

- The default `npm test` starts Vitest in **watch mode**; use `npx vitest run` for non-interactive CI-style runs.
- To run the server, build first (`npm run build`), then `npm start -- /path/to/config.json`. A sample config is at `sample/config.json` but it includes an HTTPS server requiring SSL certs. For HTTP-only testing, create a config with only the first server entry.
- `/stats.json` endpoint on the running server returns tracker statistics (torrents, peers, memory).
- `uWebSockets.js` is a native C++ addon fetched from GitHub; `npm install` handles it automatically.