mymakerofficial/sql-zen

A web-based SQL editor that lets you run databases right in your browser.

SqlZen

Database tooling that runs everywhere.

Development

Project Setup

1. Install Node.js

Download and install Node.js from nodejs.org.

2. Install Dependencies

npm install

3. Setup Rust and Tauri (Optional)

We use Tauri to build the desktop app. Follow the installation guide to setup Rust and Tauri.

4. Troubleshooting

You may need to restart your terminal or IDE after installing Rust for the first time.

Compile and Hot-Reload for Development

Web only

npm run dev

Desktop app

npm run tauri dev

Initial launch may take a while as Vite needs to optimize some dependencies.

Type-Check, Compile and Minify for Production

Web only

npm run build

Desktop app

npm run tauri build

Check Types

It's recommended to check types before pushing changes to make sure the app can be built successfully.

npm run type-check

Lint with ESLint

npm run lint