Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/suwayomi/suwayomi-vaadinui
A simple Client for Suwayomi written in Java with Vaadin
https://github.com/suwayomi/suwayomi-vaadinui
desktop manga spring-boot suwayomi tachidesk tachiyomi ui vaadin
Last synced: about 2 hours ago
JSON representation
A simple Client for Suwayomi written in Java with Vaadin
- Host: GitHub
- URL: https://github.com/suwayomi/suwayomi-vaadinui
- Owner: Suwayomi
- License: mpl-2.0
- Created: 2023-06-11T09:08:42.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2024-10-24T01:51:34.000Z (25 days ago)
- Last Synced: 2024-10-24T17:52:36.428Z (24 days ago)
- Topics: desktop, manga, spring-boot, suwayomi, tachidesk, tachiyomi, ui, vaadin
- Language: Java
- Homepage:
- Size: 7.19 MB
- Stars: 19
- Watchers: 3
- Forks: 2
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://app.deepsource.com/gh/Suwayomi/Suwayomi-VaadinUI/)
# Tachidesk-VaadinUI
A free and open source manga reader that
uses [Tachidesk-Server](https://github.com/Suwayomi/Tachidesk-Server).
This is written in Java with the help of the Vaadin Framework.
# Is this Application usable?
Yes, but any bug reports are welcome. If you want to contribute, please do so.
Here's a list of features that are currently implemented:
- [x] Managing Extensions
- [x] Exploring Sources
- [x] Searching for Manga
- [x] Reading Manga/Chapters
- [x] Downloading Manga/Chapters
- [x] Managing Manga in a Library
- [x] Managing Categories
- [x] External Server Instance Support
- [x] Tracking via AniList
- [x] Search via AniList
# How do I get this Application
## Releases
Just download your applicable installer from the releases tab and install it on your device.
## Flathub/Flatpak
You can also install this Application on Linux by using Flatpak with the Flathub repo, all you have to do is paste the following command into your terminal (with the flathub repo already added).
```bash
flatpak install online.hatsune_miku.tachidesk-vaadinui
```
You can then run the Application by using this
```bash
flatpak run online.hatsune_miku.tachidesk-vaadinui
```
# Troubleshooting
## I started the Application, but it doesn't open in my browser
You can manually open the Application by going to http://localhost:3901 or go in the task tray and
double click the icon there.
# Support and Help
Join the [Discord Server](https://discord.com/invite/DDZdqZWaHA) and ask your questions in the
#support channel. You can Ping @diamondlp. Note that I might not respond immediately.
# How do I build this Application
## Jar
To build a jar file, just run 'gradlew buildReleaseJar'. The jar file will be located in the
build/libs folder and should be named Tachidesk-VaadinUI-x.y.z.jar.
## Windows
To build a Windows installer, just run 'gradlew buildWindowsExe' for an .exe installer or 'gradlew
buildWindowsMsi' for an .msi installer (recommended). The installer will be located in the
build/installer folder.
## Linux
To build a Linux installer, just run 'gradlew buildLinuxDeb' for a Debian based Linux distribution
or 'gradlew buildLinuxRpm' for a RPM based Linux distribution. The installer will be located in the
build/installer folder.
## MacOS
To build a MacOS installer, just run 'gradlew buildMacDmg' for a .dmg file or 'gradlew buildMacPkg'
for a .pkg file. Whichever you prefer. The installer will be located in the build/installer folder.
# Development Guidelines
## Formatting
Please use the Google Java Format to format your code. You can find an IntelliJ plugin, which will format the code for
you [here](https://plugins.jetbrains.com/plugin/8527-google-java-format).
## Commit Messages
Explain what the commit does in a simple manner. Don't explain the whole algorithm you implemented, but rather what the
commit does. For example: "Add support for reading Manga" or "Fix bug where Manga Page doesn't load correctly".
## Pull Requests
Please make sure that your code compiles and runs before making a pull request. Also make sure that your code is well
formatted. If you want to make a pull request, feel free to do so. I'll review it and if it's good, I'll merge it in a
timely manner.
**Note**: If you want to make a big change, please open an issue first and discuss if the change is needed/wanted. This
way you won't have done a lot of work for nothing and I won't have to reject your pull request.
## Code
Please make sure your code is readable and follows the guidelines above. Also make sure new methods are documented with
a proper JavaDoc. For example:
```java
/**
* This method returns the {@link Manga} title.
*
* @param mangaId The id of the Manga to get the tile from.
* @return The title of the Manga.
*/
public String getMangaTitle(String mangaId) {
/* Code here
*/
}
```
# Credit
The `Tachidesk-Server` project is developed by [AriaMoradi](https://github.com/AriaMoradi) and other
contributors. Feel free to check it out [here](https://github.com/Suwayomi/Tachidesk-Server).