Skip to content
 
 

Latest commit

 

History

362 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Scriptum

A self-hosted, browser-based IDE for learning FRC robot programming. Students get a hosted VS Code editor, isolated Docker workspaces, one-click robot simulation, live AdvantageScope/Elastic Dashboard telemetry, and a Choreo path/auto editor — all with no local setup. Lesson modules guide beginners, while GitHub team import supports real robot projects.

Quick Start

Try Scriptum locally in demo mode — no Legion setup, no configuration required. Just Docker:

git clone https://github.com/mathewdunne/CodeRunner scriptum
cd scriptum
SCRIPTUM_DEMO_MODE=1 docker compose up

Open http://localhost:4000. You land directly in the IDE as a single seeded admin user.

Prerequisites: Docker with the Compose plugin (running). No Bun, Flutter, submodules, or emscripten needed — the control image ships the web shell, AdvantageScope, and Choreo assets prebuilt (Elastic Dashboard too, if the published image was built with it — see decision 041). On macOS and native Windows there is nothing to configure; on Linux and WSL2 (Docker Desktop's WSL2 integration included) the socket belongs to the docker group, so prefix the command with SCRIPTUM_DOCKER_GID=$(stat -c '%g' /var/run/docker.sock) or set that variable in .env.

Warning: Demo mode bypasses authentication entirely. Every visitor shares the same admin user and workspace. Do not expose a demo instance to the public internet. See docs/quick-start.md for full details and next steps.

Documentation

Documentation lives in docs/ and is built with Docusaurus from website/. To browse locally:

cd website && bun install && bun run start

Or from the repo root:

bun run docs:dev

Main sections:

Development

Start the control plane and web shell in parallel:

bun run dev:control   # Bun control plane on :4000 with --watch
bun run dev:web       # Vite web shell on :5173 with HMR

Run the full verification suite before submitting changes:

bun run verify        # typecheck + Bun tests + Vitest + Playwright

See docs/development/dev-servers.md for the full development workflow.

License

Scriptum is released under the MIT License.

It redistributes third-party software that remains under its own terms — most notably AdvantageScope (BSD-3-Clause, modified), Choreo (BSD-3-Clause, unmodified fork), Elastic Dashboard (MIT, modified), VSCodium (MIT), and WPILib (BSD-3-Clause). Required notices are in THIRD_PARTY_NOTICES.md and ship inside both images at /usr/share/scriptum/. None of those projects endorse or are affiliated with Scriptum.

About

A self-hosted, browser-based IDE with AdvantageScope telemetry for learning FRC robot programming.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages