2020-12-24 15:31:21 +03:30
# Tachidesk
A not so much port of [Tachiyomi ](https://tachiyomi.org/ ) to the web (and later Electron for the desktop experience)!
This project has two components:
2020-12-24 15:34:07 +03:30
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
2020-12-24 15:31:21 +03:30
## How do I run the thing?
2021-01-19 21:40:44 +03:30
### Get Android stubs jar(do this only once)
#### Manual download
Download [android.jar ](https://raw.githubusercontent.com/AriaMoradi/Tachidesk/android-jar/android.jar ) and put it under `AndroidCompat/lib` .
#### Building from source(needs `bash`, `curl`, `base64`, `zip` to work)
2021-01-19 21:41:37 +03:30
run `scripts/getAndroid.sh` from project's root directory to download and rebuild the jar file from Google's repository.
2021-01-20 03:17:43 +03:30
### building the jar
2021-01-20 12:24:47 +03:30
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.
2021-01-20 03:17:43 +03:30
## running for development purposes
2020-12-24 15:31:21 +03:30
### The Server
2021-01-20 03:41:22 +03:30
run `./gradlew :server:run -x :webUI:copyBuild --stacktrace` to run the server
2020-12-24 15:31:21 +03:30
### the webUI
how to do it is described in `webUI/react/README.md` but for short,
2020-12-24 22:36:39 +03:30
first cd into `webUI/react` then run `yarn` to install the node modules(do this only once)
2020-12-24 15:46:42 +03:30
then `yarn start` to start the client if a new browser window doesn't start automatically,
2020-12-24 15:31:21 +03:30
then open `http://127.0.0.1:3000` in a modern browser.
2021-01-20 03:19:45 +03:30
## Is the application usable? Should I test it?
2020-12-25 03:37:59 +03:30
Checkout [the state of project ](https://github.com/AriaMoradi/Tachidesk/issues/2 ) to see what's implemented.
2020-12-25 03:35:23 +03:30
2021-01-21 13:41:03 +03:30
## Credit
2021-01-21 13:58:49 +03:30
The `AndroidCompat` module and `scripts/getAndroid.sh` was originally developed by [@null-dev ](https://github.com/null-dev ) for [TachiWeb-Server ](https://github.com/Tachiweb/TachiWeb-server ) and is licensed under `Apache License Version 2.0` .
2021-01-21 13:42:17 +03:30
Parts of [tachiyomi ](https://github.com/tachiyomiorg/tachiyomi ) is adopted into this codebase, also licensed under `Apache License Version 2.0` .
2021-01-21 13:41:03 +03:30
2020-12-24 15:31:21 +03:30
## License
2021-01-21 13:58:15 +03:30
Copyright (C) 2020-2021 Aria Moradi and contributors
2020-12-24 15:31:21 +03:30
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
2021-01-03 03:16:17 +03:30
file, You can obtain one at http://mozilla.org/MPL/2.0/.
