diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..adfd257f --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,46 @@ +# Contributing +## Where should I start? +Checkout [This Kanban Board](https://github.com/Suwayomi/Tachidesk/projects/1) to see the rough development roadmap, one of the columns is reseved for potential + +## How does Tachidesk work? +This project has two components: +1. **server:** contains the implementation of [tachiyomi's extensions library](https://github.com/tachiyomiorg/extensions-lib) and uses an Android compatibility library to run apk extensions. All this concludes to serving a REST API to `webUI`. +2. **webUI:** A react SPA(`create-react-app`) project that works with the server to do the presentation. + +This structure is chosen to achieve the maximum multi-platform-ness and to eaise development of alternative user intefaces for Tachidesk. + +## Alternative User Interfaces for Tachidesk server +Currently there are three known interfaces for Tachidesk: +1. [webUI](https://github.com/Suwayomi/Tachidesk/tree/master/webUI/react): The react SPA that Tachidesk is traditionally shipped with. +2. [TachideskJUI](https://github.com/Suwayomi/TachideskJUI): A Jetbrains Compose Native app, re-uses components made for the upcoming Tachiyomi 1.x +3. [Equinox](https://github.com/Suwayomi/Equinox): A web user interface made with Vue.js, in super early stages of development. + + +## Building from source +### Prerequisite: Get Android stubs jar +#### Manual download +Download [android.jar](https://raw.githubusercontent.com/Suwayomi/Tachidesk/android-jar/android.jar) and put it under `AndroidCompat/lib`. +#### Automated download +Run `AndroidCompat/getAndroid.sh`(MacOS/Linux) or `AndroidCompat/getAndroid.ps1`(Windows) from project's root directory to download and rebuild the jar file from Google's repository. +### Prerequisite: Software dependencies +You need this software packages installed in order to build this project: +- Java Development Kit and Java Runtime Environment version 8 or newer(both Oracle JDK and OpenJDK works) +- Nodejs LTS or latest +- Yarn +- Git +### building the full-blown jar +Run `./gradlew :webUI:copyBuild server:shadowJar`, the resulting built jar file will be `server/build/Tachidesk-vX.Y.Z-rxxx.jar`. +### building without `webUI` bundled(server only) +Delete the `server/src/main/resources/react` directory if exists from previous runs, then run `./gradlew server:shadowJar`, the resulting built jar file will be `server/build/Tachidesk-vX.Y.Z-rxxx.jar`. +### building the Windows package +Run `./gradlew :server:windowsPackage` to build a server only bundle and `./gradlew :webUI:copyBuild :server:windowsPackage` to get a full bundle , the resulting built zip package file will be `server/build/Tachidesk-vX.Y.Z-rxxx-win32.zip`. +## Running for development purposes +### `server` module +Follow [Get Android stubs jar](#prerequisite-get-android-stubs-jar) then run `./gradlew :server:run --stacktrace` to run the server +### `webUI` module +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 development server, if a new browser window doesn't get opned automatically, + then open `http://127.0.0.1:3000` in a modern browser. This is a `create-react-app` project + and supports HMR and all the other goodies you'll need. +