Docs · Reference
Set up Orbit for local development, understand the available scripts, and learn the conventions that keep the codebase small and predictable.
This page covers working on Orbit itself. For installing and using the app, see Installation and the Quick start.
git clone https://github.com/dagisolo10/Orbit.git
cd Orbit
bun install| Script | What it does |
|---|---|
dev | Run Orbit in development with hot reload |
typecheck | Type-check the main/preload and renderer projects |
lint | Run ESLint with autofix |
format | Format the codebase with Prettier |
build | Type-check, then produce a production build |
start | Preview the production build |
build:linux / build:mac / build:win | Package a distributable for that platform |
build:unpack | Package an unpacked build (great for testing) |
build:arch | Build a pacman package for Arch Linux |
Fork the repository on GitHub, make your change on a branch, and open a pull request. Before submitting, run the checks the project uses:
bun run typecheck
bun run lint
bun run buildBug reports and feature requests are welcome on the issue tracker.
Part of the Orbit documentation · v1.0.0