Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/advplyr/audiobookshelf-app
Mobile application for Audiobookshelf
https://github.com/advplyr/audiobookshelf-app
android audiobooks audiobookshelf ios
Last synced: about 11 hours ago
JSON representation
Mobile application for Audiobookshelf
- Host: GitHub
- URL: https://github.com/advplyr/audiobookshelf-app
- Owner: advplyr
- License: gpl-3.0
- Created: 2021-09-02T01:06:39.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2024-12-27T23:13:30.000Z (14 days ago)
- Last Synced: 2025-01-03T00:02:06.549Z (8 days ago)
- Topics: android, audiobooks, audiobookshelf, ios
- Language: Vue
- Homepage: https://audiobookshelf.org
- Size: 19.5 MB
- Stars: 1,410
- Watchers: 19
- Forks: 183
- Open Issues: 325
-
Metadata Files:
- Readme: readme.md
- License: LICENSE
Awesome Lists containing this project
README
# Audiobookshelf Mobile App
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.**
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)
**Requires an Audiobookshelf server to connect with**
## 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.
### Localization
Thank you to [Weblate](https://hosted.weblate.org/engage/audiobookshelf/) 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](https://www.audiobookshelf.org/faq#how-do-i-help-with-translations). 
### Windows Environment Setup for Android
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)
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;
```
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/) (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
```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
Generate static web app:
```shell
npm run generate
```
Expand for screenshot
Copy web app into native android/ios folders:
```shell
npx cap sync
```
Expand for screenshot
Open Android Studio:
```shell
npx cap open android
```
Expand for screenshot
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
Generate static web app:
```shell
npm run generate
```
Expand for screenshot
Copy web app into native android/ios folders:
```shell
npx cap sync
```
Expand for screenshot
Open Xcode:
```shell
npx cap open ios
```
Expand for screenshot
Start coding!