2020-12-24 13:01:21 +01:00
# 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 13:04:07 +01:00
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 13:01:21 +01:00
## How do I run the thing?
2021-01-19 19:10:44 +01:00
### 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 19:11:37 +01:00
run `scripts/getAndroid.sh` from project's root directory to download and rebuild the jar file from Google's repository.
2021-01-20 00:47:43 +01:00
### building the jar
2021-01-20 09:54:47 +01:00
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 00:47:43 +01:00
## running for development purposes
2020-12-24 13:01:21 +01:00
### The Server
2021-01-20 01:11:22 +01:00
run `./gradlew :server:run -x :webUI:copyBuild --stacktrace` to run the server
2020-12-24 13:01:21 +01:00
### the webUI
how to do it is described in `webUI/react/README.md` but for short,
2020-12-24 20:06:39 +01:00
first cd into `webUI/react` then run `yarn` to install the node modules(do this only once)
2020-12-24 13:16:42 +01:00
then `yarn start` to start the client if a new browser window doesn't start automatically,
2020-12-24 13:01:21 +01:00
then open `http://127.0.0.1:3000` in a modern browser.
2021-01-20 00:49:45 +01:00
## Is the application usable? Should I test it?
2020-12-25 01:07:59 +01:00
Checkout [the state of project ](https://github.com/AriaMoradi/Tachidesk/issues/2 ) to see what's implemented.
2020-12-25 01:05:23 +01:00
2020-12-24 13:01:21 +01:00
## License
2021-01-20 01:12:01 +01:00
Copyright (C) 2020-2021 Aria Moradi
2020-12-24 13:01:21 +01:00
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 00:46:17 +01:00
file, You can obtain one at http://mozilla.org/MPL/2.0/.
