ghedwards / sqlectron-gui

A simple and lightweight SQL client desktop with cross database and platform support.

A simple and lightweight SQL client with cross database and platform support.

Demo (version 1.0.0)

Current supported databases

• PostgreSQL
• MySQL
• Microsoft SQL Server

Do you wanna support for another SQL database? Please send a pull request to sqlectron-core.

Download

All versions available are at the release page.

Terminal

SQLECTRON has also a terminal-based interface called sqlectron-term.

Configuration

See the available configuration at here.

Development

• Required node 4 or higher.

Running the application:

# first shell window
npm run dev:webpack

# second shell window
npm run dev:electron

Setup databases

You can test it using your own database or use a docker-compose built for us to bring up several different databases.

Testing changes of sqlectron-core

This is an easy way to test sqlectron-core changes from the GUI. But please do not forget including some unit tests on sqlectron-core before applying a pull request.

Link the dependency to the original project:

# from sqlectron-gui folder
./scripts/link-sqlectron-core.sh

Auto compile the sqlectron-core every time a change is done:

# from sqlectron-core folder
npm run watch

Then follow the steps to run the GUI application.

Build

1. npm install
2. npm run dist
3. The installer will be placed at dist folder.

Building windows apps from non-windows platforms

You will need follow it or build through the docker:

docker-compose run dist