diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 00000000..d89b284a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,37 @@ +--- +name: Bug report +about: Create a report to help us improve +labels: bug + +--- + +### Steps to reproduce + +1. +2. +3. + +### Expected behaviour +- Tell us what should happen + +### Actual behaviour +- Tell us what happens + +### Environment data + +Audiobookshelf Version: + +- [ ] Android App? +- [ ] iOS App? + +#### Android Issue +Android version: + +Device model: + +Stock or customized system: + +#### iOS Issue +iOS Version: + +iPhone model: diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 00000000..9d995c6f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,18 @@ +--- +name: Feature request +about: Suggest an idea for this project +labels: enhancement + +--- + +### Is your feature request related to a problem? Please describe. +A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + +### Describe the solution you'd like +A clear and concise description of what you want to happen. + +### Describe alternatives you've considered +A clear and concise description of any alternative solutions or features you've considered. + +### Additional context +Add any other context or screenshots about the feature request here. diff --git a/readme.md b/readme.md index cf4a4930..dba94ffc 100644 --- a/readme.md +++ b/readme.md @@ -11,3 +11,178 @@ Get the Android app on the [Google Play Store](https://play.google.com/store/app **Currently in Beta** - **Requires an Audiobookshelf server to connect with** Screenshot1 + + +## Contributing + +This application is built using [NuxtJS](https://nuxtjs.org/) and [Capacitor](https://capacitorjs.com/) in order to run on both iOS and Android on the same code base. + +### Windows Environment Setup for Android + +Required Software: + +* [Git](https://git-scm.com/downloads) +* [Node.js](https://nodejs.org/en/) +* Code editor of choice([VSCode](https://code.visualstudio.com/download), etc) +* [Android Studio](https://developer.android.com/studio) +* [Android SDK](https://developer.android.com/studio) + +
+Install the required software with winget + +

+Note: This requires a PowerShell prompt with winget installed. You should be able to copy and paste the code block to install. If you use an elevated PowerShell prompt, UAC will not pop up during the installs. + +```PowerShell +winget install -e --id Git.Git; ` +winget install -e --id Microsoft.VisualStudioCode; ` +winget install -e --id Google.AndroidStudio; ` +winget install -e --id OpenJS.NodeJS --version 16.12.0; #v17 has issues with openssl +``` + +![](/screenshots/dev_setup_windows_winget.png) + +

+
+
+ +Your Windows environment should now be set up and ready to proceed! + +### Mac Environment Setup for Android + +Required Software: + +* [Android Studio](https://developer.android.com/studio) +* [Node.js](https://nodejs.org/en/) +* [Cocoapods](https://guides.cocoapods.org/using/getting-started.html#installation) +* [Android SDK](https://developer.android.com/studio) + +
+Install the required software with homebrew + +

+ +```zsh +brew install android-studio node cocoapods +``` + +

+
+ +### Start working on the Android app + +Clone or fork the project from terminal or powershell and `cd` into the project directory. + +Install the required node packages: +```shell +npm install +``` + +
+Expand for screenshot + +![](/screenshots/dev_setup_android_npm_install.png) +
+
+ +Generate static web app: +```shell +npm run generate +``` + +
+Expand for screenshot + +![](/screenshots/dev_setup_android_npm_run.png) +
+
+ +Copy web app into native android/ios folders: +```shell +npx cap sync +``` + +
+Expand for screenshot + +![](/screenshots/dev_setup_android_cap_sync.png) +
+
+ +Open Android Studio: + +```shell +npx cap open android +``` + +
+Expand for screenshot + +![](/screenshots/dev_setup_cap_android.png) +
+
+ +Start coding! + +### Mac Environment Setup for iOS + +Required Software: + +* [Xcode](https://developer.apple.com/xcode/) +* [Node.js](https://nodejs.org/en/) +* [Cocoapods](https://guides.cocoapods.org/using/getting-started.html#installation) + +### Start working on the iOS app + +Clone or fork the project in the terminal and `cd` into the project directory. + +Install the required node packages: +```shell +npm install +``` + +
+Expand for screenshot + +![](/screenshots/dev_setup_ios_npm_install.png) +
+
+ +Generate static web app: +```shell +npm run generate +``` + +
+Expand for screenshot + +![](/screenshots/dev_setup_ios_npm_generate.png) +
+
+ +Copy web app into native android/ios folders: +```shell +npx cap sync +``` + +
+Expand for screenshot + +![](/screenshots/dev_setup_ios_cap_sync.png) +
+
+ +Open Xcode: + +```shell +npx cap open ios +``` + +
+Expand for screenshot + +![](/screenshots/dev_setup_ios_cap_open.png) +
+
+ +Start coding! diff --git a/screenshots/dev_setup_android_cap_sync.png b/screenshots/dev_setup_android_cap_sync.png new file mode 100755 index 00000000..6c66b4b3 Binary files /dev/null and b/screenshots/dev_setup_android_cap_sync.png differ diff --git a/screenshots/dev_setup_android_npm_install.png b/screenshots/dev_setup_android_npm_install.png new file mode 100755 index 00000000..43a07e2f Binary files /dev/null and b/screenshots/dev_setup_android_npm_install.png differ diff --git a/screenshots/dev_setup_android_npm_run.png b/screenshots/dev_setup_android_npm_run.png new file mode 100755 index 00000000..4fb81866 Binary files /dev/null and b/screenshots/dev_setup_android_npm_run.png differ diff --git a/screenshots/dev_setup_cap_android.png b/screenshots/dev_setup_cap_android.png new file mode 100755 index 00000000..c34cce25 Binary files /dev/null and b/screenshots/dev_setup_cap_android.png differ diff --git a/screenshots/dev_setup_ios_cap_open.png b/screenshots/dev_setup_ios_cap_open.png new file mode 100644 index 00000000..84938c1b Binary files /dev/null and b/screenshots/dev_setup_ios_cap_open.png differ diff --git a/screenshots/dev_setup_ios_cap_sync.png b/screenshots/dev_setup_ios_cap_sync.png new file mode 100644 index 00000000..3d794c0c Binary files /dev/null and b/screenshots/dev_setup_ios_cap_sync.png differ diff --git a/screenshots/dev_setup_ios_npm_generate.png b/screenshots/dev_setup_ios_npm_generate.png new file mode 100644 index 00000000..7c2e69d1 Binary files /dev/null and b/screenshots/dev_setup_ios_npm_generate.png differ diff --git a/screenshots/dev_setup_ios_npm_install.png b/screenshots/dev_setup_ios_npm_install.png new file mode 100644 index 00000000..070692cc Binary files /dev/null and b/screenshots/dev_setup_ios_npm_install.png differ diff --git a/screenshots/dev_setup_windows_winget.png b/screenshots/dev_setup_windows_winget.png new file mode 100755 index 00000000..af8b0aea Binary files /dev/null and b/screenshots/dev_setup_windows_winget.png differ