|
|
@ -9,8 +9,19 @@ For a quick dev environment setup, use [pkgx](https://pkgx.dev). |
|
|
|
- Node.js (LTS version recommended) |
|
|
|
- npm (comes with Node.js) |
|
|
|
- Git |
|
|
|
- For iOS builds: macOS with Xcode installed |
|
|
|
- For Android builds: Android Studio with SDK installed |
|
|
|
- For iOS builds: macOS with Xcode and ruby gems & bundle |
|
|
|
- pkgx +rubygems.org sh |
|
|
|
|
|
|
|
- ... and you may have to fix these, especially with pkgx |
|
|
|
|
|
|
|
```bash |
|
|
|
gem_path=$(which gem) |
|
|
|
shortened_path="${gem_path:h:h}" |
|
|
|
export GEM_HOME=$shortened_path |
|
|
|
export GEM_PATH=$shortened_path |
|
|
|
``` |
|
|
|
|
|
|
|
- For desktop builds: Additional build tools based on your OS |
|
|
|
|
|
|
|
## Forks |
|
|
@ -22,7 +33,7 @@ If you have forked this to make your own app, you'll want to customize the iOS & |
|
|
|
npx cap add ios |
|
|
|
``` |
|
|
|
|
|
|
|
You'll also want to edit the deep link configuration. |
|
|
|
You'll also want to edit the deep link configuration (see below). |
|
|
|
|
|
|
|
## Initial Setup |
|
|
|
|
|
|
@ -59,7 +70,7 @@ To build for web deployment: |
|
|
|
|
|
|
|
## Desktop Build (Electron) |
|
|
|
|
|
|
|
### Building for Linux |
|
|
|
### Linux Build |
|
|
|
|
|
|
|
1. Build the electron app in production mode: |
|
|
|
|
|
|
@ -142,6 +153,12 @@ Prerequisites: macOS with Xcode installed |
|
|
|
|
|
|
|
4. Use Xcode to build and run on simulator or device. |
|
|
|
|
|
|
|
### First-time iOS Configuration |
|
|
|
|
|
|
|
- Generate certificates inside XCode. |
|
|
|
|
|
|
|
- Right-click on App and under Signing & Capabilities set the Team. |
|
|
|
|
|
|
|
### Android Build |
|
|
|
|
|
|
|
Prerequisites: Android Studio with SDK installed |
|
|
@ -174,7 +191,7 @@ Prerequisites: Android Studio with SDK installed |
|
|
|
|
|
|
|
5. Use Android Studio to build and run on emulator or device. |
|
|
|
|
|
|
|
## Building Android from the console |
|
|
|
## Android Build from the console |
|
|
|
|
|
|
|
```bash |
|
|
|
cd android |
|
|
@ -191,7 +208,7 @@ Prerequisites: Android Studio with SDK installed |
|
|
|
``` |
|
|
|
|
|
|
|
|
|
|
|
## Configuring Android for deep links |
|
|
|
## First-time Android Configuration for deep links |
|
|
|
|
|
|
|
You must add the following intent filter to the `android/app/src/main/AndroidManifest.xml` file: |
|
|
|
|
|
|
|