From 9121703e31036cfb172ebc577651d52f0f332829 Mon Sep 17 00:00:00 2001 From: arkon Date: Sat, 31 Jul 2021 16:35:06 -0400 Subject: [PATCH] Remove some Tachidesk-specific project boilerplate --- .github/ISSUE_TEMPLATE/bug_report.md | 44 ------------------- .github/ISSUE_TEMPLATE/config.yml | 5 ++- .github/ISSUE_TEMPLATE/feature_request.md | 29 ------------- .github/workflows/build_pull_request.yml | 1 - .github/workflows/build_push.yml | 1 - CODE_OF_CONDUCT.md | 5 --- CONTRIBUTING.md | 52 ----------------------- README.md | 16 ++++--- settings.gradle.kts | 2 +- 9 files changed, 15 insertions(+), 140 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md delete mode 100644 .github/ISSUE_TEMPLATE/feature_request.md delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index 5284110..0000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -name: "🐞 Bug report" -title: "[Bug] " -about: "Report a bug" -labels: "bug" ---- - -**PLEASE READ THIS** - -I acknowledge that: - -- I have updated to the latest version of the app. -- I have tried the troubleshooting guide described in `README.md` -- If this is a request for adding/changing an extension it should be brought up to Tachiyomi: https://github.com/tachiyomiorg/tachiyomi-extensions/issues/new/choose -- If this is an issue with some extension not working properly, It does work inside Tachiyomi as intended. -- I have searched the existing issues and this is a new ticket **NOT** a duplicate or related to another open issue -- I will fill out the title and the information in this template - -Note that the issue will be automatically closed if you do not fill out the title or requested information. - -**DELETE THIS SECTION IF YOU HAVE READ AND ACKNOWLEDGED IT** - ---- - -## Device information -- Tachidesk version: (Example: v0.2.3-r255-win32) -- Server Operating System: (Example: Ubuntu 20.04) -- Server Desktop Environment: N/A or (Example: Gnome 40) -- Server JVM version: bundled with win32 or (Example: Java 8 Update 281 or OpenJDK 8u281) -- Client Operating System: -- Client Web Browser: (Example: Google Chrome 89.0.4389.82) - -## Steps to reproduce -1. First Step -2. Second Step - -### Expected behavior -Describe what should have happened. Remove this line after you are done. - -### Actual behavior -Describe what happens instead. Remove this line after you are done. - -## Other details -Describe additional details If necessary. Remove this line after you are done. \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 3ba13e0..953d5b4 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1 +1,4 @@ -blank_issues_enabled: false +contact_links: + - name: ⚠️ Extension/source issue + url: https://github.com/tachiyomiorg/tachiyomi-extensions/issues/new/choose + about: Issues and requests for extensions and sources should be opened in the tachiyomi-extensions repository instead diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index a59f281..0000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -name: "🌟 Feature request" -title: "[Feature Request] " -about: "Suggest a feature to improve the project" -labels: "enhancement" ---- - -**PLEASE READ THIS** - -I acknowledge that: - -- I have updated to the latest version of the app. -- I have tried the troubleshooting guide described in `README.md` -- If this is a request for adding/changing an extension it should be brought up to Tachiyomi: https://github.com/tachiyomiorg/tachiyomi-extensions/issues/new/choose -- If this is an issue with some extension not working properly, It does work in Tachiyomi application as intended. -- I have searched the existing issues and this is a new ticket **NOT** a duplicate or related to another open issue -- I will fill out the title and the information in this template - -Note that the issue will be automatically closed if you do not fill out the title or requested information. - -**DELETE THIS SECTION IF YOU HAVE READ AND ACKNOWLEDGED IT** - ---- - -## What feature should be added to Tachidesk? -Explain What the feature is and how it should work in detail. Remove this line after you are done. - -## Why/Project's Benefit/Existing Problem -Explain why this should be added. Remove this line after you are done. \ No newline at end of file diff --git a/.github/workflows/build_pull_request.yml b/.github/workflows/build_pull_request.yml index dd758bf..3078d0b 100644 --- a/.github/workflows/build_pull_request.yml +++ b/.github/workflows/build_pull_request.yml @@ -18,7 +18,6 @@ jobs: build: name: Build pull request needs: check_wrapper - if: "!startsWith(github.event.head_commit.message, '[SKIP CI]')" runs-on: ubuntu-latest steps: diff --git a/.github/workflows/build_push.yml b/.github/workflows/build_push.yml index 5981758..f1359b4 100644 --- a/.github/workflows/build_push.yml +++ b/.github/workflows/build_push.yml @@ -20,7 +20,6 @@ jobs: build: name: Build artifacts and deploy preview needs: check_wrapper - if: "!startsWith(github.event.head_commit.message, '[SKIP CI]')" runs-on: ubuntu-latest steps: diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md deleted file mode 100644 index 46d60c9..0000000 --- a/CODE_OF_CONDUCT.md +++ /dev/null @@ -1,5 +0,0 @@ -# Code Of Conduct -- Don't be a dick. - -# expanding the code of conduct! -The contents of this document is up for debate and improvement! Discussions on discord. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md deleted file mode 100644 index 2d9d3c8..0000000 --- a/CONTRIBUTING.md +++ /dev/null @@ -1,52 +0,0 @@ -# Contributing -## Where should I start? -Checkout [This Kanban Board](https://github.com/Suwayomi/Tachidesk/projects/1) to see the rough development roadmap. - -**Note to potential contributors:** Notify the developers on Suwayomi discord (#programming channel) or open a WIP pull request before starting if you decide to take on working on anything from/not from the roadmap in order to avoid parallel efforts on the same issue/feature. - -## 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. - -## Why a web app? -This structure is chosen to -- Achieve the maximum multi-platform-ness -- Gives the ability to acces Tachidesk from a remote web browser e.g. your phone, tablet or smart TV -- Eaise development of alternative user intefaces for Tachidesk - -## 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 -### Prerequisites -You need these software packages installed in order to build the project -### Server -- Java Development Kit and Java Runtime Environment version 8 or newer(both Oracle JDK and OpenJDK works) -- 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. -### webUI -- 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 -First Build the jar, then cd into the `scripts` directory and run `./windows-bundler.sh` (or `./windows-bundler.ps1` if you are on windows), the resulting built zip package file will be `server/build/Tachidesk-vX.Y.Z-rxxx-win64.zip`. -## Running in development mode -First satisfy [the prerequisites](#prerequisites) -### server -run `./gradlew :server:run --stacktrace` to run the server -### 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 development server, if a new browser window doesn't get opened 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. - diff --git a/README.md b/README.md index e285648..b7629f5 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,9 @@ -# Inspector +# Extensions inspector + This is a headless fork of [Tachidesk](https://github.com/AriaMoradi/Tachidesk) that is used to inspect Tachiyomi's extension sources. -## Credit +## Credits + The `AndroidCompat` module 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`. Parts of [tachiyomi](https://github.com/tachiyomiorg/tachiyomi) is adopted into this codebase, also licensed under `Apache License Version 2.0`. @@ -12,8 +14,10 @@ Changes to both codebases is licensed under `MPL v. 2.0` as the rest of this pro ## License - Copyright (C) Contributors to the Suwayomi project +``` +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/. +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/. +``` \ No newline at end of file diff --git a/settings.gradle.kts b/settings.gradle.kts index ec5358f..041d99a 100644 --- a/settings.gradle.kts +++ b/settings.gradle.kts @@ -1,4 +1,4 @@ -rootProject.name = System.getenv("ProductName") ?: "Tachidesk" +rootProject.name = "Tachiyomi Extensions Inspector" include("server")