tachiyomi-extensions-inspector/README.md
2021-01-21 13:58:15 +03:30

2.3 KiB

Tachidesk

A not so much port of Tachiyomi to the web (and later Electron for the desktop experience)!

This project has two components:

  1. server: contains some of the original Tachiyomi code and serves a REST API
  2. webUI: A react project that works with the server to do the presentation

How do I run the thing?

Get Android stubs jar(do this only once)

Manual download

Download android.jar and put it under AndroidCompat/lib.

Building from source(needs bash, curl, base64, zip to work)

run scripts/getAndroid.sh from project's root directory to download and rebuild the jar file from Google's repository.

building the jar

run ./gradlew :server:shadowJar the resulting jar file will be server/build/server-1.0-all.jar. Simply double click on it or run java -jar server-1.0-all.jar. The server will be running on http://localhost:4567 open this url in your browser.

running for development purposes

The Server

run ./gradlew :server:run -x :webUI:copyBuild --stacktrace to run the server

the webUI

how to do it is described in webUI/react/README.md but for short, first cd into webUI/react then run yarn to install the node modules(do this only once) then yarn start to start the client if a new browser window doesn't start automatically, then open http://127.0.0.1:3000 in a modern browser.

Is the application usable? Should I test it?

Checkout the state of project to see what's implemented.

Credit

The AndroidCompat and scripts/getAndroid.sh module is originally developed by @null-dev for TachiWeb-Server and is licensed under Apache License Version 2.0.

Parts of tachiyomi is adopted into this codebase, also licensed under Apache License Version 2.0.

License

Copyright (C) 2020-2021 Aria Moradi and contributors

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/.