diff --git a/readme.md b/readme.md index ade4acde..b0d6150c 100644 --- a/readme.md +++ b/readme.md @@ -3,24 +3,25 @@ Audiobookshelf is a self-hosted audiobook and podcast server. ### Android (beta) + Get the Android app on the [Google Play Store](https://play.google.com/store/apps/details?id=com.audiobookshelf.app) ### iOS (early beta) -**Beta is currently full. Apple has a hard limit of 10k beta testers. Updates will be posted in Discord/Matrix.** -Using Test Flight: https://testflight.apple.com/join/wiic7QIW ***(beta is full)*** +**Beta is currently full. Apple has a hard limit of 10k beta testers. Updates will be posted in Discord.** + +Using Test Flight: https://testflight.apple.com/join/wiic7QIW **_(beta is full)_** --- [Go to the main project repo github.com/advplyr/audiobookshelf](https://github.com/advplyr/audiobookshelf) or the project site [audiobookshelf.org](https://audiobookshelf.org) -Join us on [discord](https://discord.gg/pJsjuNCKRq) or [Matrix](https://matrix.to/#/#audiobookshelf:matrix.org) +Join us on [discord](https://discord.gg/pJsjuNCKRq) **Requires an Audiobookshelf server to connect with** Screenshot - ## 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. @@ -31,11 +32,11 @@ Information on helping with translations of the apps [here](https://www.audioboo Required Software: -* [Git](https://git-scm.com/downloads) -* [Node.js](https://nodejs.org/en/) (version 20) -* 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) +- [Git](https://git-scm.com/downloads) +- [Node.js](https://nodejs.org/en/) (version 20) +- 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 @@ -62,10 +63,10 @@ Your Windows environment should now be set up and ready to proceed! Required Software: -* [Android Studio](https://developer.android.com/studio) -* [Node.js](https://nodejs.org/en/) (version 20) -* [Cocoapods](https://guides.cocoapods.org/using/getting-started.html#installation) -* [Android SDK](https://developer.android.com/studio) +- [Android Studio](https://developer.android.com/studio) +- [Node.js](https://nodejs.org/en/) (version 20) +- [Cocoapods](https://guides.cocoapods.org/using/getting-started.html#installation) +- [Android SDK](https://developer.android.com/studio)
Install the required software with homebrew @@ -84,6 +85,7 @@ brew install android-studio node cocoapods Clone or fork the project from terminal or powershell and `cd` into the project directory. Install the required node packages: + ```shell npm install ``` @@ -92,10 +94,12 @@ npm install Expand for screenshot ![](/screenshots/dev_setup_android_npm_install.png) +

Generate static web app: + ```shell npm run generate ``` @@ -104,10 +108,12 @@ 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 ``` @@ -116,6 +122,7 @@ npx cap sync Expand for screenshot ![](/screenshots/dev_setup_android_cap_sync.png) +
@@ -129,6 +136,7 @@ npx cap open android Expand for screenshot ![](/screenshots/dev_setup_cap_android.png) +
@@ -138,15 +146,16 @@ Start coding! Required Software: -* [Xcode](https://developer.apple.com/xcode/) -* [Node.js](https://nodejs.org/en/) -* [Cocoapods](https://guides.cocoapods.org/using/getting-started.html#installation) +- [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 ``` @@ -155,10 +164,12 @@ npm install Expand for screenshot ![](/screenshots/dev_setup_ios_npm_install.png) +
Generate static web app: + ```shell npm run generate ``` @@ -167,10 +178,12 @@ 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 ``` @@ -179,6 +192,7 @@ npx cap sync Expand for screenshot ![](/screenshots/dev_setup_ios_cap_sync.png) +
@@ -192,6 +206,7 @@ npx cap open ios Expand for screenshot ![](/screenshots/dev_setup_ios_cap_open.png) +