add android apk and update deploy instructions

This commit is contained in:
WieErWill 2021-06-21 14:18:57 +02:00
parent beb85d78b4
commit 20f40a30d4
2 changed files with 47 additions and 50 deletions

View File

@ -7,6 +7,10 @@ The authors of the project warn about the damage alcohol does and don't take any
All the cocktail recipes are for information only. All the cocktail recipes are for information only.
No food bloggers, bartenders or programmers were harmed in the making of this project. No food bloggers, bartenders or programmers were harmed in the making of this project.
## Download
- [Android Release APK](android/app/release/app-release.apk)
- [Android Debug APK](android/app/build/outputs/apk/debug/app-debug.apk)
## Contribution ## Contribution
- the (CocktailDB)[https://www.thecocktaildb.com/] API; you can add your own API Key - the (CocktailDB)[https://www.thecocktaildb.com/] API; you can add your own API Key
- Cocktails: [International Bartenders Association (Teijo)](https://github.com/teijo/iba-cocktails) - Cocktails: [International Bartenders Association (Teijo)](https://github.com/teijo/iba-cocktails)
@ -15,6 +19,7 @@ No food bloggers, bartenders or programmers were harmed in the making of this pr
- Library for Apps [Ionic](https://github.com/ionic-team/ionic) - Library for Apps [Ionic](https://github.com/ionic-team/ionic)
- JS Framework [Vue](https://github.com/vuejs/vue) - JS Framework [Vue](https://github.com/vuejs/vue)
- cross-platform compability [Capacitor](https://github.com/ionic-team/capacitor) - cross-platform compability [Capacitor](https://github.com/ionic-team/capacitor)
- Logo made with Ionic [Get started](https://ionicframework.com/start#basics) Tool
## Develop locally ## Develop locally
1. download the installer](https://nodejs.org/) for Node LTS 1. download the installer](https://nodejs.org/) for Node LTS
@ -25,33 +30,24 @@ No food bloggers, bartenders or programmers were harmed in the making of this pr
6. run `ionic serve` in a terminal from the project root 6. run `ionic serve` in a terminal from the project root
7. follow the link in the console to view the app in the browser or smartphone 7. follow the link in the console to view the app in the browser or smartphone
### Deploy ### Build & Deploy
To deploy everything to a production-ready app, run this command: 1. To create a current build run `npm run build` or `ionic build`; all files in `/dist` will be created and/or updated
```sh 2. after each building process update your capacitor: `ionic cap copy`
ionic build 3. after each big updates or changes in code sync your capacitor: `ionic cap sync`
```
This will build and update all files in the `dist/` folder
### Build general - Web build
1. update the Capacitor config after each standard build process: `ionic cap copy` - already done in `dist/`
2. sync Capacitor builds after each new Plugin or huge code change: `ionic cap sync` - [Android build](https://ionicframework.com/docs/developing/android)
1. [AndroidStudio](https://developer.android.com/studio/) required
- Android build 2. open app in android studio `ionic cap open android`
1. you need [Android SDK](https://developer.android.com/studio/). 3. update android permissions: `android/app/src/main/AndroidManifest.xml`
- the easiest way on a Mac is `homebrew`: `brew install android-sdk` 4. to publish app to appstore add your [signature](https://developer.android.com/studio/publish/app-signing). For local development an example is at `android/signing/keystore.properties.example`
- on Linux you can use the package manager: `sudo apt-get install android-sdk` or via 5. May adjust your `storeFile` for the correct platform `storeFile=~/.android/debug.keystore`
- [Flatpak](https://flathub.org/apps/details/com.google.AndroidStudio) or - [iOS build](https://ionicframework.com/docs/developing/ios)
- [Snap](https://uappexplorer.com/snap/ubuntu/android-studio) 1. `XCode` on a Mac required
2. open the app in your AndroidStudio `ionic cap open android` 2. open app in Xcode `ionic cap open ios`
3. to publish the app you need to [sign](https://developer.android.com/studio/publish/app-signing) it. For local testing, a sample file is available at 3. update iOS permissions inside Xcode with tab "Info"
```sh 4. create your apps signature with tab `Signing & Capabilities`
cp android/signing/keystore.properties.example
```
4. you may need to adjust the value of `storeFile` for your platform
```sh
storeFile=~/.android/debug.keystore
```
- iOS build open in XCode `ionic cap open ios`
# License # License
The project runs under the [MIT](./LICENSE) licence. The project runs under the [MIT](./LICENSE) licence.

View File

@ -15,13 +15,19 @@ Die Autoren des Projekts warnen vor den Schäden, die Alkohol anrichtet, und üb
Alle Cocktailrezepte dienen nur zur Information. Alle Cocktailrezepte dienen nur zur Information.
Bei der Erstellung dieses Projekts wurden keine Food-Blogger, Barkeeper oder Programmierer geschädigt. Bei der Erstellung dieses Projekts wurden keine Food-Blogger, Barkeeper oder Programmierer geschädigt.
## Download
- [Android Release APK](android/app/release/app-release.apk)
- [Android Debug APK](android/app/build/outputs/apk/debug/app-debug.apk)
## Quellen und Bibliotheken ## Quellen und Bibliotheken
- die (CocktailDB)[https://www.thecocktaildb.com/] API; der eigene API Schlüssel kann in der App gespeichert werden - die [CocktailDB](https://www.thecocktaildb.com/) API; der eigene API Schlüssel kann in der App gespeichert werden
- Cocktails der [International Bartenders Association (Teijo)](https://github.com/teijo/iba-cocktails) - Cocktails der [International Bartenders Association (Teijo)](https://github.com/teijo/iba-cocktails), bereitgestellt durch [Teijo](https://github.com/teijo/)
- [Gläser](https://github.com/mikeyhogarth/cocktails) - [Gläser Icons von mikeyhogarth](https://github.com/mikeyhogarth/cocktails)
- Bibliothek für Apps [Ionic](https://github.com/ionic-team/ionic) - Bibliothek für Apps [Ionic](https://github.com/ionic-team/ionic)
- JS Framework [Vue](https://github.com/vuejs/vue) - JS Framework [Vue](https://github.com/vuejs/vue)
- Kompabilität für mobile Systeme [Capacitor](https://github.com/ionic-team/capacitor) - Kompabilität für mobile Systeme [Capacitor](https://github.com/ionic-team/capacitor)
- das Logo wurde mit dem Ionic [Get started](https://ionicframework.com/start#basics) Tool erzeugt
## Lokal weiterentwickeln ## Lokal weiterentwickeln
1. Installiere [NodeJS](https://nodejs.org/) in der aktuellen LTS Version (>=14.15) 1. Installiere [NodeJS](https://nodejs.org/) in der aktuellen LTS Version (>=14.15)
@ -32,33 +38,28 @@ Bei der Erstellung dieses Projekts wurden keine Food-Blogger, Barkeeper oder Pro
6. den Entwicklungsserver mit `ionic serve` starten 6. den Entwicklungsserver mit `ionic serve` starten
7. Folge dem Link in der Konsole um die App im Browser oder Smartphone zu betrachten 7. Folge dem Link in der Konsole um die App im Browser oder Smartphone zu betrachten
## Deploy
Um alles für eine Produktionsfertige App bereitzustellen führe diesen Befehl aus:
```sh
npm run build
```
Das wird alle Dateien im `dist/` Ordner erstellen und updaten
### Build general ### Build & Deploy
1. bei jedem Build Prozess müssen die Capacitor Ordner aktualisiert werden: `ionic cap copy` 1. Um alles für eine produktionsfertige App bereitzustellen führe `npm run build` oder `ionic build` aus. Das erstellt und updatet alle Dateien im `dist/` Ordner (für Webseiten Deploy)
2. nach Updates oder großen Änderungen des Codes (neues Plugin) muss Capacitor synchronisiert werden: `ionic cap sync` 2. nach jedem Build Prozess müssen die Capacitor Ordner aktualisiert werden: `ionic cap copy`
3. nach Updates oder großen Änderungen des Codes (neues Plugin) muss Capacitor synchronisiert werden: `ionic cap sync`
- Android build - Web build
1. Du benötigst die [Android SDK](https://developer.android.com/studio/). - ist bereits fertig im `dist/` Ordner verfügbar
- der einfachste Weg auf einem Mac ist `homebrew`: `brew install android-sdk` - [Android build](https://ionicframework.com/docs/developing/android)
- auf Linux kann man den Paketmanager nutzen: `sudo apt-get install android-sdk` or via 1. Du benötigst [AndroidStudio](https://developer.android.com/studio/)
- [Flatpak](https://flathub.org/apps/details/com.google.AndroidStudio) or
- [Snap](https://uappexplorer.com/snap/ubuntu/android-studio)
2. die App im Android Studio öffnen `ionic cap open android` 2. die App im Android Studio öffnen `ionic cap open android`
3. Um die App zu veröffentlichen benötigst musst du diese [signieren](https://developer.android.com/studio/publish/app-signing). Für lokale Tests ist eine Beispieldatei unter 3. Android benötigt eine Übersicht nötiger Berechtigungen in `android/app/src/main/AndroidManifest.xml`
```sh 4. Um die App im AppStore zu veröffentlichen benötigst musst du diese [signieren](https://developer.android.com/studio/publish/app-signing). Für lokale Tests ist eine Beispieldatei unter `android/signing/keystore.properties.example`
cp android/signing/keystore.properties.example 5. Möglicherweise musst du den Wert von `storeFile` für deine Platform anpassen
```
4. Möglicherweise musst du den Wert von `storeFile` für deine Platform anpassen
```sh ```sh
storeFile=~/.android/debug.keystore storeFile=~/.android/debug.keystore
``` ```
- iOS build in XCode öffnen `ionic cap open ios` - [iOS build](https://ionicframework.com/docs/developing/ios)
1. es wird `XCode` auf einem Mac benötigt
2. die App in XCode öffnen `ionic cap open ios`
3. in XCode müssen die Berechtigungen und Berechtigungstexte angepasst werden, zu finden im Tab "Info"
4. die App muss signiert werden über `Signing & Capabilities`
## Lizenz ## Lizenz
Das Projekt läuft unter der [MIT](./LICENSE) Lizenz. Das Projekt läuft unter der [MIT](./LICENSE) Lizenz.