search

advplyr / audiobookshelf-app

Mobile application for Audiobookshelf
https://audiobookshelf.org
GNU General Public License v3.0
1.33k stars 174 forks source link
android audiobooks audiobookshelf ios

readme

Audiobookshelf Mobile App

Audiobookshelf is a self-hosted audiobook and podcast server.

Android (beta)

Get the Android app on the Google Play Store

iOS (early beta)

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 or the project site audiobookshelf.org

Join us on discord

Requires an Audiobookshelf server to connect with

Screenshot

Contributing

This application is built using NuxtJS and Capacitor in order to run on both iOS and Android on the same code base.

Localization

Thank you to Weblate for hosting our localization infrastructure pro-bono. If you want to see Audiobookshelf in your language, please help us localize. Additional information on helping with the translations here. Translation status

Windows Environment Setup for Android

Required Software:

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 20.11.0; ``` ![](/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:

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:

npm install
Expand for screenshot ![](/screenshots/dev_setup_android_npm_install.png)


Generate static web app:

npm run generate
Expand for screenshot ![](/screenshots/dev_setup_android_npm_run.png)


Copy web app into native android/ios folders:

npx cap sync
Expand for screenshot ![](/screenshots/dev_setup_android_cap_sync.png)


Open Android Studio:

npx cap open android
Expand for screenshot ![](/screenshots/dev_setup_cap_android.png)


Start coding!

Mac Environment Setup for iOS

Required Software:

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:

npm install
Expand for screenshot ![](/screenshots/dev_setup_ios_npm_install.png)


Generate static web app:

npm run generate
Expand for screenshot ![](/screenshots/dev_setup_ios_npm_generate.png)


Copy web app into native android/ios folders:

npx cap sync
Expand for screenshot ![](/screenshots/dev_setup_ios_cap_sync.png)


Open Xcode:

npx cap open ios
Expand for screenshot ![](/screenshots/dev_setup_ios_cap_open.png)


Start coding!