Built in the open.

The source

The app combines a Rust/Tauri database core with a React interface. The website lives in its own website/ folder.

Local development

Install Node.js 24, Rust, and your platform’s Tauri prerequisites, then:

git clone https://github.com/Kraksz/AstralSQL.git
cd AstralSQL
npm ci
npm test
npm run desktop

To run only the SQLite browser workspace, use npm run dev. For the website, run npm run build and npm run website:sync from the root, then npm ci and npm run dev inside website/.

Contributing

Read CONTRIBUTING.md, SECURITY.md, and the release checklist before opening a pull request. Include a reproducible test for database behavior changes. Never commit database credentials, local data files, signing keys, or private hosting configuration.

The included GitHub workflows check the frontend and database core. Windows, Linux, and macOS packaging jobs prepare beta artifacts; actual platform verification is required before publishing installers.

GitBook publishing

This handbook uses a GitBook-style reading layout here on the Astral site. The repository also includes a Markdown handbook and .gitbook.yaml so its owner can connect it to an actual GitBook workspace using Git Sync.

In GitBook, select the repository and branch, import the repository’s docs, and review before publishing. A GitBook-hosted URL requires the owner’s GitBook workspace. See GitBook’s Git Sync guide.