● Start · What you need
Requirements
free to start.
What you need to run the Stack, what is optional and what you do not need. Nothing ships with a MIKODES key, account or fee address.
01Required
| What | Why |
|---|---|
| Node.js 20.12 or newer with npm | The admin declares "engines": { "node": ">=20.12" } in admin/package.json. The data jobs run on Node 20 in the workflow. Checked with Node 22.22.2 and npm 10.9.7 on macOS. |
| A GitHub account and a repository you own (private or public) | The refresh job runs on GitHub Actions, not on your computer. |
| A static web host | The public pages are plain HTML, CSS, JavaScript and JSON. vercel.json is included for Vercel; any static host works. |
| Git | To push the code and to commit config/public.json after you change settings. |
02Optional
| What | When you need it |
|---|---|
| A Polymarket account with a builder profile | Only to record your own builder code. See Builder code. |
| Your own Polygon RPC URL | Recommended. Add it as the GitHub repository secret POLYGON_RPC_URL and the refresh job reads the chain from it first (how); without it the job uses three public keyless RPCs. The same URL can also go into the admin's Integrations for the Status check. |
| A Telegram bot token | Only for the admin's telegramBot check. No bot runtime ships. |
| A webhook endpoint | To receive the Admin Kit's alerts (Notifications). |
| Python 3 | Only for the local preview python3 -m http.server. |
03What you do not need
- No API keys. Kalshi, Polymarket's Gamma and order-book read endpoints and the public Polygon RPCs are unauthenticated.
- No database server. The pages read static JSON. The admin keeps its settings in a local SQLite file (
admin/data/admin.sqlite). - No application server in production. The admin runs on your computer and is never deployed.
- No MIKODES service. You run your own copy.
04Platform notes
- The admin depends on
better-sqlite3, which normally downloads a prebuilt binary duringnpm install. Without one it compiles from source and needs a C++ toolchain (macOS:xcode-select --install). Only macOS (Apple silicon) was checked for these docs. - The public pages load the Inter and JetBrains Mono fonts from Google Fonts. Offline, system fonts take over. The admin bundles its own fonts and needs no internet for them.