Skip to content

getting-started.md

Latest commit

 

History

History
89 lines (64 loc) · 2.15 KB

getting-started.md

File metadata and controls

89 lines (64 loc) · 2.15 KB
Raw

Getting started

How to build and run Querya Desktop from source.

Prerequisites

  • Flutter SDK (stable channel) with desktop enabled:

    flutter config --enable-linux-desktop   # or --enable-windows-desktop / --enable-macos-desktop

  • Linux also needs the desktop headers used by Flutter and its plugins (GTK, etc.). For flutter_secure_storage you typically need libsecret-1-dev:

    sudo apt install libsecret-1-dev      # Debian / Ubuntu
sudo dnf install libsecret-devel      # Fedora

    CI pins a specific stable Flutter version; matching it locally avoids "works on my machine" drift (see Contributing).

Install

From the project root:

flutter pub get

If the platform folders are missing:

flutter create . --project-name querya_desktop --platforms=linux,windows,macos
flutter pub get

Run

# Linux
flutter run -d linux
# On Wayland, force X11 to avoid Gdk pointer warnings:
GDK_BACKEND=x11 flutter run -d linux
# Or use the helper script:
./run_linux.sh

# Windows
flutter run -d windows

# macOS
flutter run -d macos

Build release

flutter build linux
flutter build windows
flutter build macos

First connection

  1. Launch the app.
  2. Connection → New Database Connection (or right-click Servers in the tree).
  3. Pick PostgreSQL, MySQL, Redis, or MongoDB and fill in host, port, and credentials.
  4. Saved connections appear in the left tree.

See the User guide for preferences, the driver manager, and day-to-day usage, and Security for how credentials are stored.

Local dev databases (optional)

The repo includes a Docker Compose stack under docker/ with PostgreSQL, MySQL, MongoDB, Redis, ClickHouse, and SQLite seed data:

cp docker/.env.example docker/.env   # optional overrides
cd docker && docker compose up -d

Default credentials: user/password querya, database querya (MongoDB auth source: admin; ClickHouse HTTP 8123, native 9000). Stop with docker compose down.