starred/audiobookshelf-app
1
0
Fork 0
mirror of https://github.com/advplyr/audiobookshelf-app.git synced 2026-08-30 23:27:17 +02:00
Code Issues 454 Packages Projects Releases 10 Wiki Activity

Remove references to matrix server

Browse Source
This commit is contained in:
advplyr
2024-07-23 16:22:24 -05:00
parent 03a46decba
commit 2b1e53b371
1 changed files with 31 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files
readme.md
+31 -16
View File
@@ -3,24 +3,25 @@
Audiobookshelf is a self-hosted audiobook and podcast server. Audiobookshelf is a self-hosted audiobook and podcast server.
### Android (beta) ### Android (beta)
Get the Android app on the [Google Play Store](https://play.google.com/store/apps/details?id=com.audiobookshelf.app) Get the Android app on the [Google Play Store](https://play.google.com/store/apps/details?id=com.audiobookshelf.app)
### iOS (early beta) ### 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) [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** **Requires an Audiobookshelf server to connect with**
<img alt="Screenshot" src="https://github.com/advplyr/audiobookshelf-app/raw/master/screenshots/DeviceDemoScreens.png" /> <img alt="Screenshot" src="https://github.com/advplyr/audiobookshelf-app/raw/master/screenshots/DeviceDemoScreens.png" />
## Contributing ## 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. 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: Required Software:
* [Git](https://git-scm.com/downloads) - [Git](https://git-scm.com/downloads)
* [Node.js](https://nodejs.org/en/) (version 20) - [Node.js](https://nodejs.org/en/) (version 20)
* Code editor of choice([VSCode](https://code.visualstudio.com/download), etc) - Code editor of choice([VSCode](https://code.visualstudio.com/download), etc)
* [Android Studio](https://developer.android.com/studio) - [Android Studio](https://developer.android.com/studio)
* [Android SDK](https://developer.android.com/studio) - [Android SDK](https://developer.android.com/studio)
<details> <details>
<summary>Install the required software with <a href=(https://docs.microsoft.com/en-us/windows/package-manager/winget/#production-recommended)>winget</a></summary> <summary>Install the required software with <a href=(https://docs.microsoft.com/en-us/windows/package-manager/winget/#production-recommended)>winget</a></summary>
@@ -62,10 +63,10 @@ Your Windows environment should now be set up and ready to proceed!
Required Software: Required Software:
* [Android Studio](https://developer.android.com/studio) - [Android Studio](https://developer.android.com/studio)
* [Node.js](https://nodejs.org/en/) (version 20) - [Node.js](https://nodejs.org/en/) (version 20)
* [Cocoapods](https://guides.cocoapods.org/using/getting-started.html#installation) - [Cocoapods](https://guides.cocoapods.org/using/getting-started.html#installation)
* [Android SDK](https://developer.android.com/studio) - [Android SDK](https://developer.android.com/studio)
<details> <details>
<summary>Install the required software with <a href=(https://brew.sh/)>homebrew</a></summary> <summary>Install the required software with <a href=(https://brew.sh/)>homebrew</a></summary>
@@ -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. Clone or fork the project from terminal or powershell and `cd` into the project directory.
Install the required node packages: Install the required node packages:
```shell ```shell
npm install npm install
``` ```
@@ -92,10 +94,12 @@ npm install
<summary>Expand for screenshot</summary> <summary>Expand for screenshot</summary>
![](/screenshots/dev_setup_android_npm_install.png) ![](/screenshots/dev_setup_android_npm_install.png)
</details> </details>
<br> <br>
Generate static web app: Generate static web app:
```shell ```shell
npm run generate npm run generate
``` ```
@@ -104,10 +108,12 @@ npm run generate
<summary>Expand for screenshot</summary> <summary>Expand for screenshot</summary>
![](/screenshots/dev_setup_android_npm_run.png) ![](/screenshots/dev_setup_android_npm_run.png)
</details> </details>
<br> <br>
Copy web app into native android/ios folders: Copy web app into native android/ios folders:
```shell ```shell
npx cap sync npx cap sync
``` ```
@@ -116,6 +122,7 @@ npx cap sync
<summary>Expand for screenshot</summary> <summary>Expand for screenshot</summary>
![](/screenshots/dev_setup_android_cap_sync.png) ![](/screenshots/dev_setup_android_cap_sync.png)
</details> </details>
<br> <br>
@@ -129,6 +136,7 @@ npx cap open android
<summary>Expand for screenshot</summary> <summary>Expand for screenshot</summary>
![](/screenshots/dev_setup_cap_android.png) ![](/screenshots/dev_setup_cap_android.png)
</details> </details>
<br> <br>
@@ -138,15 +146,16 @@ Start coding!
Required Software: Required Software:
* [Xcode](https://developer.apple.com/xcode/) - [Xcode](https://developer.apple.com/xcode/)
* [Node.js](https://nodejs.org/en/) - [Node.js](https://nodejs.org/en/)
* [Cocoapods](https://guides.cocoapods.org/using/getting-started.html#installation) - [Cocoapods](https://guides.cocoapods.org/using/getting-started.html#installation)
### Start working on the iOS app ### Start working on the iOS app
Clone or fork the project in the terminal and `cd` into the project directory. Clone or fork the project in the terminal and `cd` into the project directory.
Install the required node packages: Install the required node packages:
```shell ```shell
npm install npm install
``` ```
@@ -155,10 +164,12 @@ npm install
<summary>Expand for screenshot</summary> <summary>Expand for screenshot</summary>
![](/screenshots/dev_setup_ios_npm_install.png) ![](/screenshots/dev_setup_ios_npm_install.png)
</details> </details>
<br> <br>
Generate static web app: Generate static web app:
```shell ```shell
npm run generate npm run generate
``` ```
@@ -167,10 +178,12 @@ npm run generate
<summary>Expand for screenshot</summary> <summary>Expand for screenshot</summary>
![](/screenshots/dev_setup_ios_npm_generate.png) ![](/screenshots/dev_setup_ios_npm_generate.png)
</details> </details>
<br> <br>
Copy web app into native android/ios folders: Copy web app into native android/ios folders:
```shell ```shell
npx cap sync npx cap sync
``` ```
@@ -179,6 +192,7 @@ npx cap sync
<summary>Expand for screenshot</summary> <summary>Expand for screenshot</summary>
![](/screenshots/dev_setup_ios_cap_sync.png) ![](/screenshots/dev_setup_ios_cap_sync.png)
</details> </details>
<br> <br>
@@ -192,6 +206,7 @@ npx cap open ios
<summary>Expand for screenshot</summary> <summary>Expand for screenshot</summary>
![](/screenshots/dev_setup_ios_cap_open.png) ![](/screenshots/dev_setup_ios_cap_open.png)
</details> </details>
<br> <br>