Surrealist

https://github.com/surrealdb/surrealist
Admin
Surrealist is a user interface for interacting with SurrealDB databases visually, enabling query...
Tokens:7,879
Snippets:191
Trust Score:9.8
Update:3 months ago
Show doc for...
Tokens:
Raw
### Install Frontend Dependencies

Source: https://github.com/surrealdb/surrealist/blob/main/CONTRIBUTING.md

Installs the necessary frontend dependencies for the project using Bun. Run this command once after cloning the repository.

```bash
bun install
```

--------------------------------

### Build Desktop App Release

Source: https://github.com/surrealdb/surrealist/blob/main/CONTRIBUTING.md

Creates installers and bundles for the current platform (e.g., .dmg, .deb, .msi). Output is located under `src-tauri/target/release/bundle/`.

```bash
bun run tauri:build
```

--------------------------------

### Build Desktop Binary Without Bundling

Source: https://github.com/surrealdb/surrealist/blob/main/CONTRIBUTING.md

Compiles the desktop binary without creating installers or bundles. The executable will be available in `src-tauri/target/release/`.

```bash
bun run tauri build -- --no-bundle
```

--------------------------------

### Run Web App in Development

Source: https://github.com/surrealdb/surrealist/blob/main/CONTRIBUTING.md

Starts the web application in development mode with hot reloading enabled. Accessible at http://localhost:1420.

```bash
bun run dev
```

--------------------------------

### Preview Production Build

Source: https://github.com/surrealdb/surrealist/blob/main/CONTRIBUTING.md

Locally previews the production build of the static web assets. Useful for testing before deployment.

```bash
bun run preview
```

--------------------------------

### Run Compiled Desktop Binary

Source: https://github.com/surrealdb/surrealist/blob/main/CONTRIBUTING.md

Executes the compiled desktop binary directly from the command line. The path varies by platform.

```bash
./src-tauri/target/release/surrealist
```

--------------------------------

### Build Static Web Assets

Source: https://github.com/surrealdb/surrealist/blob/main/CONTRIBUTING.md

Compiles the static web assets for production deployment. Output is placed in the `dist/` directory.

```bash
bun run build
```

--------------------------------

### Run Desktop App in Development

Source: https://github.com/surrealdb/surrealist/blob/main/CONTRIBUTING.md

Launches the Surrealist desktop application within the Tauri shell, enabling hot reloading for development.

```bash
bun run tauri:dev
```

--------------------------------

### Import SCSS modules

Source: https://github.com/surrealdb/surrealist/blob/main/AGENTS.md

Use this syntax to import SCSS modules for component styling.

```ts
import classes from "./style.module.scss";
```

--------------------------------

### Code Quality Checks

Source: https://github.com/surrealdb/surrealist/blob/main/CONTRIBUTING.md

Runs various code quality checks including formatting, linting, and TypeScript type checking. Use `qa` to apply fixes.

```bash
bun run qa   # format and lint (applies fixes)
```

```bash
bun run qc   # verify formatting and lint
```

```bash
bun run qts  # TypeScript type check
```
Tokens:
Raw