antares/README.md

115 lines
6.1 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-05-22 17:33:03 +02:00
![GitHub package.json version](https://img.shields.io/github/package-json/v/fabio286/antares) [![Build Status](https://img.shields.io/endpoint.svg?url=https%3A%2F%2Factions-badge.atrox.dev%2Ffabio286%2Fantares%2Fbadge&style=flat)](https://actions-badge.atrox.dev/fabio286/antares/goto) ![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) [![Twitter Follow](https://img.shields.io/twitter/follow/AntaresSQL?style=social)](https://twitter.com/AntaresSQL) [![Plant a Tree](https://raw.githubusercontent.com/Fabio286/treedom-badge/master/svg/plant-a-tree.svg)](https://www.treedom.net/en/user/fabio-di-stasio/event/antares-for-the-planet)
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.
2021-07-27 17:18:11 +02:00
Our target is to support as many databases as possible, and all major operating systems, including the ARM versions.
2020-07-24 14:05:14 +02:00
2021-07-07 12:59:27 +02:00
**At the moment this application is in development state, many features will come in future updates**, and supports only MySQL/MariaDB and PostgreSQL.
At the moment, however, there are all the features necessary to have a pleasant database management experience, so give it a chance and send us your feedback, we would really appreciate it.
We are actively working on it, hoping to provide new cool features, improvements 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).
2021-05-30 10:54:58 +02:00
👁 To stay tuned for new releases [follow Antares SQL](https://twitter.com/AntaresSQL) on Twitter.
2020-09-28 10:14:12 +02:00
🌟 Don't forget to **leave a star** if you appreciate this project.
2020-07-24 14:05:14 +02:00
2021-08-02 19:26:56 +02:00
## Current key features
- Multiple database connections at same time.
- Database management (add/edit/delete).
- Full tables management, including indexes and foreign keys.
- Views, triggers, stored routines, functions and schedulers management (add/edit/delete).
- A modern and friendly tab system; keep open every kind of tab you need in your workspace.
- Fake table data filler to generate tons of data for test purpose.
- Query suggestions and auto complete.
- SSH tunnel support.
- Dark and light theme.
- Editor themes.
- Scratchpad.
- Secure password storage.
2020-08-21 15:56:29 +02:00
## Philosophy
2020-08-10 18:09:33 +02:00
2021-07-07 12:59:27 +02:00
Why are we 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-07-07 12:59:27 +02:00
A modern application created with minimalism and semplicity in mind, with features in the right places, not hundreds of tiny buttons, nested tabs or submenu; productivity comes first.
2020-08-10 18:09:33 +02:00
2021-08-02 19:26:56 +02:00
## Installation
2021-03-31 10:59:19 +02:00
2021-08-02 19:26:56 +02:00
Based on your operating system you can have one or more distribution formats to choose based on your preferences.
Since Antares SQL is a free software we haven't a budget to spend in annual licenses or certificates. This can result that on some platforms you need some additional passages to install this app.
2021-03-31 10:59:19 +02:00
2021-08-02 19:26:56 +02:00
### Linux
2020-08-10 18:09:33 +02:00
2021-08-02 19:26:56 +02:00
On Linux you can simply download and run `.AppImage` distributions, install from Snap Store or from AUR.
2020-08-10 18:09:33 +02:00
2021-08-02 19:26:56 +02:00
### Windows
2020-10-17 17:01:38 +02:00
2021-08-02 19:26:56 +02:00
On Windows you can choose between Microsoft Store and download `.exe` distribution. The latter lacks of a certificate, so to install you need to click on "More info" and then "Run anyway" on SmartScreen prompt.
### MacOS
On macOS you can run `.dmg` distribution following [this guide](https://support.apple.com/guide/mac-help/mh40616/mac) to install apps from unknown developers.
## Download
[![Get it from the Snap Store](https://snapcraft.io/static/images/badges/en/snap-store-black.svg)](https://snapcraft.io/antares) [![Get it from AUR](https://raw.githubusercontent.com/Fabio286/antares/3e00c4bae6e036300c752c1a40c5a038fea9c169/docs/aur-badge.svg)](https://aur.archlinux.org/packages/antares-sql/) [![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)
🚀 **[Other Downloads](https://github.com/Fabio286/antares/releases/latest)**
2020-10-17 17:01:38 +02:00
## 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-01-16 11:45:44 +01:00
- Users management (add/edit/delete).
2021-07-07 12:59:27 +02:00
- Query history and bookmarks.
2020-10-17 17:01:38 +02:00
- More context menu shortcuts.
- More keyboard shortcuts.
- Import/export and migration.
2021-08-02 19:26:56 +02:00
- Apple Silicon distribution
2020-08-10 18:09:33 +02:00
2020-07-24 14:05:14 +02:00
## Currently supported
### Databases
- [x] MySQL/MariaDB
2021-07-07 12:59:27 +02:00
- [x] PostgreSQL
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-08-02 19:26:56 +02:00
- [x] MacOS
2020-07-29 15:56:29 +02:00
2020-08-21 15:56:29 +02:00
#### • ARM
- [ ] Windows
- [x] Linux
- [ ] MacOS
2020-08-21 15:56:29 +02:00
2021-08-02 19:26:56 +02:00
## How to contribute
- 🌍 [Translate Antares](https://github.com/Fabio286/antares/wiki/Translate-Antares)
- 📖 [Contributors Guide](https://github.com/Fabio286/antares/wiki/Contributors-Guide)
- 🚧 [Project Board](https://github.com/users/Fabio286/projects/1)
2020-07-29 15:56:29 +02:00
## Translations
2021-04-26 10:16:55 +02:00
**Italian Translation** / [Giuseppe Gigliotti](https://github.com/ReverbOD) [[#20](https://github.com/Fabio286/antares/pull/20)]
2021-07-27 17:18:11 +02:00
**Arabic Translation** (needs updates) / [Mohd-PH](https://github.com/Mohd-PH) [[#29](https://github.com/Fabio286/antares/pull/29)]
**Spanish Translation** (needs updates) / [hongkfui](https://github.com/hongkfui) [[#32](https://github.com/Fabio286/antares/pull/32)]
**French Translation** (needs updates) / [MrAnyx](https://github.com/MrAnyx) [[#44](https://github.com/Fabio286/antares/pull/44)]
2021-06-04 14:01:46 +02:00
**Portugues (Brasil)** / [Daniel Eduardo](https://github.com/daeleduardo) [[#54](https://github.com/Fabio286/antares/pull/54)]
**Deutsch (Deutschland)** / [Christian Ratz](https://github.com/digitalgopnik) [[#74](https://github.com/Fabio286/antares/pull/74)]