mirror of
https://github.com/advplyr/audiobookshelf-app.git
synced 2025-06-20 20:05:44 +02:00
feat: initial doc update
This commit is contained in:
parent
7331389add
commit
fb75a7fefa
6 changed files with 85 additions and 0 deletions
85
readme.md
85
readme.md
|
@ -11,3 +11,88 @@ 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**
|
||||
|
||||
<img alt="Screenshot1" src="https://github.com/advplyr/audiobookshelf-app/raw/master/screenshots/BookshelfViews.png" />
|
||||
|
||||
|
||||
## Contributing
|
||||
|
||||
### Windows Environment Setup
|
||||
|
||||
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)
|
||||
|
||||
<details>
|
||||
<summary>Install the applications with <a href=(https://docs.microsoft.com/en-us/windows/package-manager/winget/#production-recommended)>winget</a></summary>
|
||||
|
||||
<p>
|
||||
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
|
||||
```
|
||||
|
||||

|
||||
|
||||
</p>
|
||||
</details>
|
||||
<br>
|
||||
|
||||
Your Windows environment should now be set up and ready to proceed!
|
||||
|
||||
### Mac Environment Setup
|
||||
|
||||
|
||||
### Start working on the project
|
||||
|
||||
|
||||
Clone or fork the project from cmd or powershell and `cd` into the project directory.
|
||||
|
||||
Install the required node packages:
|
||||
```
|
||||
npm install
|
||||
```
|
||||
<details>
|
||||
<summary>Expand for screenshot</summary>
|
||||
|
||||

|
||||
</details>
|
||||
<br>
|
||||
Generate static web app:
|
||||
```
|
||||
npm run generate
|
||||
```
|
||||
<details>
|
||||
<summary>Expand for screenshot</summary>
|
||||
|
||||

|
||||
</details>
|
||||
<br>
|
||||
|
||||
Copy web app into native android/ios folders:
|
||||
```
|
||||
npx cap sync
|
||||
```
|
||||
<details>
|
||||
<summary>Expand for screenshot</summary>
|
||||
|
||||

|
||||
</details>
|
||||
<br>
|
||||
|
||||
Open Android Studio:
|
||||
```
|
||||
npx cap open android
|
||||
```
|
||||
<details>
|
||||
<summary>Expand for screenshot</summary>
|
||||
|
||||

|
||||
</details>
|
||||
|
||||
Start coding!
|
BIN
screenshots/dev_setup_cap_android.png
Executable file
BIN
screenshots/dev_setup_cap_android.png
Executable file
Binary file not shown.
After Width: | Height: | Size: 145 KiB |
BIN
screenshots/dev_setup_cap_sync.png
Executable file
BIN
screenshots/dev_setup_cap_sync.png
Executable file
Binary file not shown.
After Width: | Height: | Size: 136 KiB |
BIN
screenshots/dev_setup_npm_install.png
Executable file
BIN
screenshots/dev_setup_npm_install.png
Executable file
Binary file not shown.
After Width: | Height: | Size: 88 KiB |
BIN
screenshots/dev_setup_npm_run.png
Executable file
BIN
screenshots/dev_setup_npm_run.png
Executable file
Binary file not shown.
After Width: | Height: | Size: 100 KiB |
BIN
screenshots/dev_setup_windows_winget.png
Executable file
BIN
screenshots/dev_setup_windows_winget.png
Executable file
Binary file not shown.
After Width: | Height: | Size: 109 KiB |
Loading…
Add table
Add a link
Reference in a new issue