antares/README.md

111 lines
4.8 KiB
Markdown
Raw Normal View History

2020-05-04 17:33:50 +02:00
<p align="center">
2021-03-14 15:38:55 +01:00
<img width="800" src="https://raw.githubusercontent.com/Fabio286/antares/master/docs/gh-logo.png">
2020-05-04 17:33:50 +02:00
</p>
2020-07-24 14:05:14 +02:00
# Antares SQL Client
2020-05-04 17:33:50 +02:00
2021-03-16 15:51:21 +01:00
![GitHub package.json version](https://img.shields.io/github/package-json/v/fabio286/antares) [![Build Status](https://travis-ci.com/Fabio286/antares.svg?branch=master)](https://travis-ci.com/Fabio286/antares) ![GitHub All Releases](https://img.shields.io/github/downloads/fabio286/antares/total) ![GitHub](https://img.shields.io/github/license/fabio286/antares) [![antares](https://snapcraft.io/antares/badge.svg)](https://snapcraft.io/antares) [![antares](https://snapcraft.io/antares/trending.svg?name=0)](https://snapcraft.io/antares)
2020-07-29 15:56:29 +02:00
Antares is an SQL client based on [Electron.js](https://github.com/electron/electron) and [Vue.js](https://github.com/vuejs/vue) that aims to become a useful tool, especially for developers.
2020-07-24 14:05:14 +02:00
My target is to support as many databases as possible, and all major operating systems, including the ARM versions.
2021-03-21 14:39:11 +01:00
**At the moment this application is in development state, many features will come in future updates**, and supports only MySQL/MariaDB and PostgreSQL (partially).
Many of its current features are enough to have a pleasant user experience with MySQL/MariaDB, and basic functionalites with PostgreSQL, so give it a chance and send me your feedback, I would really appreciate it.
I'm actively working on it, hoping to provide cool features and fixes as soon as possible.
2020-07-24 14:05:14 +02:00
2021-03-31 10:59:19 +02:00
🔗 If you are curious to try Antares you can download and install the [latest release](https://github.com/Fabio286/antares/releases/latest).
2020-09-28 10:14:12 +02:00
👁 To stay tuned for new releases watch this repo on **Release only** channel.
🌟 Don't forget to **leave a star** if you appreciate this project.
2020-07-24 14:05:14 +02:00
2020-08-21 15:56:29 +02:00
## Philosophy
2020-08-10 18:09:33 +02:00
2020-08-21 15:56:29 +02:00
Why am I developing an SQL client when there are a lot of them on the market?
2020-10-17 17:01:38 +02:00
The main goal is to develop a totally free, full featured, cross platform and open source alternative, empowered by JavaScript's ecosystem.
2021-03-25 18:33:29 +01:00
A modern application created with minimalism and semplicity in mind, with features in the right places, not hundreds of tiny buttons, tabs or submenu.
2020-08-10 18:09:33 +02:00
2021-03-31 10:59:19 +02:00
## Download
2021-04-02 15:27:29 +02:00
[![Get it from the Snap Store](https://snapcraft.io/static/images/badges/en/snap-store-black.svg)](https://snapcraft.io/antares) [![Get it from Microsoft Store](https://raw.githubusercontent.com/Fabio286/antares/gh-pages/src/assets/ms-store.png)](https://www.microsoft.com/p/antares-sql-client/9nhtb9sq51r1?cid=storebadge&ocid=badge&rtc=1&activetab=pivot:overviewtab)
2021-03-31 10:59:19 +02:00
🚀 **[Other Downloads](https://github.com/Fabio286/antares/releases/latest)**
## How to contribute
2020-08-10 18:09:33 +02:00
2020-11-30 10:04:31 +01:00
- [Translate Antares](https://github.com/Fabio286/antares/wiki/Translate-Antares)
2020-08-10 18:09:33 +02:00
2020-10-17 17:01:38 +02:00
## Current main features
- Multiple database connections at same time.
- Database management (add/edit/delete).
2020-12-15 17:23:24 +01:00
- Full tables management, including indexes and foreign keys.
2021-01-16 11:45:44 +01:00
- Views, triggers, stored routines, functions and schedulers management (add/edit/delete).
- Fake table data filler.
2020-10-17 17:01:38 +02:00
- Run queries on multiple tabs.
2020-12-23 18:07:50 +01:00
- Query suggestions and auto complete.
- Dark and light theme.
- Scratchpad.
2020-10-17 17:01:38 +02:00
- Multi language.
- Secure password storage.
2020-10-17 17:01:38 +02:00
- Auto updates.
## Coming soon
2020-08-10 18:09:33 +02:00
This is a roadmap with major features will come in near future.
2021-01-16 11:45:44 +01:00
- Support for other databases.
- Database tools.
2021-02-04 09:20:52 +01:00
- SSH tunnel support.
2021-01-16 11:45:44 +01:00
- Users management (add/edit/delete).
2020-12-15 17:23:24 +01:00
- UI/UX improvements.
2020-10-17 17:01:38 +02:00
- Query history.
- More context menu shortcuts.
- More keyboard shortcuts.
- Query logs console.
- Import/export and migration.
2020-08-10 18:09:33 +02:00
2021-02-15 09:11:48 +01:00
## Troubleshooting
### **Linux**
With KDE may need necessary installation of the additional `gnome-keyring` package.
Depending on your distribution, you will need to run the following command:
- Debian/Ubuntu: `sudo apt-get install gnome-keyring`
- Red Hat-based: `sudo yum install gnome-keyring`
- Arch Linux: `sudo pacman -S gnome-keyring`
2020-07-24 14:05:14 +02:00
## Currently supported
### Databases
- [x] MySQL/MariaDB
2021-03-21 14:39:11 +01:00
- [x] PostgreSQL (partially, work in progress)
2020-07-24 14:05:14 +02:00
- [ ] SQLite
- [ ] MSSQL
2020-07-24 14:05:14 +02:00
- [ ] OracleDB
- [ ] More...
### Operating Systems
2020-10-04 17:21:21 +02:00
#### • x64
2020-08-21 15:56:29 +02:00
2020-07-24 14:05:14 +02:00
- [x] Windows
2020-08-10 18:09:33 +02:00
- [x] Linux
2021-03-14 15:38:55 +01:00
- [x] MacOS (not tested due lack of hardware)
2020-07-29 15:56:29 +02:00
2020-08-21 15:56:29 +02:00
#### • ARM
- [ ] Windows
2020-11-16 17:17:33 +01:00
- [ ] Linux
2020-08-21 15:56:29 +02:00
- [ ] MacOS
2020-07-29 15:56:29 +02:00
## Translations
2021-01-16 11:45:44 +01:00
**Italian Translation** (46%) / [Giuseppe Gigliotti](https://github.com/ReverbOD) [[#20](https://github.com/Fabio286/antares/pull/20)]
**Arabic Translation** (45%) / [Mohd-PH](https://github.com/Mohd-PH) [[#29](https://github.com/Fabio286/antares/pull/29)]
2021-02-17 09:13:50 +01:00
**Spanish Translation** (46%) / [hongkfui](https://github.com/hongkfui) [[#32](https://github.com/Fabio286/antares/pull/32)]
**French Translation** (100%) / [MrAnyx](https://github.com/MrAnyx) [[#44](https://github.com/Fabio286/antares/pull/44)]
2021-01-14 18:11:36 +01:00
## Reviews
<a target="_blank" href="https://www.softx64.com/windows/antares-sql-client.html" title="Antares SQL Client review"><img src="https://www.softx64.com/softx64-review.png" alt="Antares SQL Client review" /></a>