An open API service indexing awesome lists of open source software.

https://github.com/xylobyte/swifty-assistant

Swifty Assistant is a simple, user-friendly, personal assistant based on an extension system.
https://github.com/xylobyte/swifty-assistant

assistant assistant-app assistant-personnel cpp home-assistant linux offline personal-assistant private-life qt5

Last synced: 3 days ago
JSON representation

Swifty Assistant is a simple, user-friendly, personal assistant based on an extension system.

Awesome Lists containing this project

README

          

# Swifty Assistant

[![License](https://img.shields.io/badge/license-GPLv3.0-blue.svg)](https://www.gnu.org/licenses/gpl-3.0.html) [![GitHub issues](https://img.shields.io/github/issues/Swiftapp-hub/Swifty-Assistant.svg)](https://github.com/Swiftapp-hub/Swifty-Assistant/issues) [![Maintained](https://img.shields.io/maintenance/yes/2022.svg)](https://github.com/Swiftapp-hub/Swifty-Assistant/commits/master)

Swifty Assistant is a simple, user-friendly assistant based on an extension system.

Swifty is a personal assistant created to be useful to both beginners and computer experts!
It works offline and does not collect any personal data!
If you like Swifty Assistant and you find it useful, please feel free to contribute to the project, thank you.
I'm French so the English version of Swifty isn't fully up to date, but if you want to improve it don't hesitate!

### Screenshoot

Capture Swifty Assistant Capture Swifty Assistant

## Get Swifty Assistant

### Install

Swifty Assistant can be installed with the online installer.

Follow the instructions below to download and install Swift Assistant:

1. [Download](https://github.com/Swiftapp-hub/Swifty-Assistant/releases/) Swifty Assistant online installer
2. Right click on the download file and go to the properties
3. Go to the permissions tab and check the box "Allow file execution as a program"
4. Now double click on the .run file to launch Swifty Assistant online installer

### Update or remove

To update or delete Swifty Assistant use the maintenance tool.

To open it here are two methods:

* Run this command `exec $HOME/SwiftyAssistant/maintenancetool`
* Open your application launcher and search for "Swifty Assistant update or remove"

## Manual installation

Follow these steps if you want to compile Swifty Assistant on your own

### Dependencies

To compile Swifty Assistant you need to have installed:

Qt >= 5.15.2 with at least the following modules:

* [qtbase](http://code.qt.io/cgit/qt/qtbase.git)
* [qtwebengine](https://code.qt.io/cgit/qt/qtwebengine.git)
* [qtquickcontrols2](https://code.qt.io/cgit/qt/qtquickcontrols2.git)

and you must have the **build-essential** package installed.

I recommend you to install Qt with the official installer from the Qt site

### Build

You need to run the following commands to compile Swifty Assistant:

```bash
cd "FOLDER_OF_GIT_CLONE"
```

```bash
lrelease SwiftyAssistant.pro
```

```bash
mkdir build && cd build
```

```bash
qmake ../
```

```bash
make
```

## Contribution

Here's what you can do to contribute to the project:

* If you want to improve this project, clone this repository
* If you want to create new plugins for Swifty or improve an existing plugin read the documentation
* If you want to improve the english traduction edit [this file](https://github.com/Swiftapp-hub/Swifty-Assistant/blob/master/ts/swiftyassistant_en.ts) with Qt Linguist and compile it with `lrelease SwiftyAssistant.pro`
* If you find a bug or if you have ideas for improvements do not hesitate to open an Issue

Thanks in advance for your help and if you like this project don't forget to put a star!

## License

This project is licensed under the GNU General Public License version 3

You will find a copy of this license in the file [LICENSE.md](https://github.com/Swiftapp-hub/Swifty-Assistant/blob/master/LICENSE.md)