Awesome
<p align="center"> <img width=200px height=200px src="assets/icons/launcher/sorayomi_icon.png" alt="Tachidesk Sorayomi logo"/> </p> <h1 align="center"> Tachidesk Sorayomi </h1> <div align="center"> </div> <div align="center"> </div> <p align="center"> A free and open source manga reader based on <a href="https://flutter.dev/">Flutter</a> to read manga from a <a href="https://github.com/Suwayomi/Tachidesk-Server">Tachidesk-Server</a> instance.</br></br> Tachidesk-Sorayomi need to connect with an already hosted server.</br></br> Tachidesk-Sorayomi supports Linux, Windows, MacOS, Web, iOS and Android. </p>Is this application usable? Should I test it?
Here is a list of current features for interaction with Tachidesk-Sorayomi:
- Managing installed Extensions.
- Interaction with your library.
- Browsing installed sources.
- Viewing manga and chapters.
- Reading, downloading, and managing chapters.
- Viewing chapter updates
Note: Keep in mind that Tachidesk-Sorayomi and Tachidesk-Server are alpha software, so it can have issues. See Support and help if it happens.
Supported Tachidesk versions
These are the versions of Tachidesk-Server that Tachidesk-Sorayomi supports.
Release build
- Tachidesk-Server v0.6.6+
Downloading and Running the app
Android
Download *-android-all.apk file from latest release the releases section.
iOS
- Download the latest .ipa file from the releases section
- use AltStore to install Sorayomi in ios.
Windows
Download the latest .msi file from the releases section.
if you use WINGET, you can run
winget install tachidesk-sorayomi
MacOS
- Download the *-macos-x64.zip from the latest release the releases section
- Extract the file.
- Drag and drop the extracted app file to applications folder in finder.
if you use HomeBrew, you can run
brew install --cask tachidesk-sorayomi
Debian based Linux
Download the latest deb release from the releases section.
Arch based Linux
Download the latest release from the aur.
If you use yay, you can run
yay -S tachidesk-sorayomi-bin
inside a terminal window.
Web
Download the latest web.zip file from the releases section.
- Sorayomi-web deployed in GitHub pages. You can check out Sorayomi here.
Post installation
- Configure your server address in
Navigation bar > more screen > Server URL
.
Building from source
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
Prerequisites
You can install Flutter & Dart from Official website
- Dart sdk
- Flutter - Channel Stable
Building
- Clone the repository:
$ git clone https://github.com/Suwayomi/Tachidesk-Sorayomi.git
$ cd Tachidesk-Sorayomi/
- You can install all dependencies by running this command in terminal:
$ flutter pub get
- Now enter the following command to start debugging the app:
$ flutter run
- Localization generator
$ flutter gen-l10n
- Pull-Request Suggestion
- Install GitHooks after cloning the repo using
git config --local core.hooksPath .githooks
- Install GitHooks after cloning the repo using
Support and help
- Join Tachidesk's discord server to hang out with the community and receive support and help.
Built Using
-
Flutter is an open source framework by Google for building beautiful, natively compiled, multi-platform applications from a single codebase.
-
Flutter Riverpod - A simple way to access state while robust and testable.
-
Riverpod Architecture - File architecture developed by @bizz84
Find other dependencies in pubspec.yaml
Credit
-
The
Tachidesk-server
project is developed by @AriaMoradi and contributors, -
The
Tachidesk-Sorayomi
project is developed by @DattatreyaReddy and contributors, -
CI-CD for
Tachidesk-Sorayomi
is developed by @mahor1221 and contributors.
Translation
Feel free to translate the project on Weblate
<details><summary>Translation Progress</summary> <a href="https://hosted.weblate.org/engage/suwayomi/"> <img src="https://hosted.weblate.org/widgets/suwayomi/-/tachidesk-sorayomi/multi-auto.svg" alt="Translation status" /> </a> </details>License
A link for Tachidesk is provided here and is licensed under Mozilla Public License v2.0
.
You can obtain a copy of Mozilla Public License v2.0
from https://mozilla.org/MPL/2.0/
Copyright (C) Contributors to the Suwayomi project
This Source Code Form is subject to the terms of the Mozilla Public
License, v. 2.0. If a copy of the MPL was not distributed with this
file, You can obtain one at http://mozilla.org/MPL/2.0/.