Click the "Use the Template" button on the repo page ⬆
We are assuming you're using a Mac for this guide. Install tools necessary.
Clone down your new repo, and run the setup script to set up environments
yarn
yarn setup
A working Rock RMS instance is required for our API to run. If you want to test that your API is functional fill out the ROCK_API and ROCK_TOKEN in your .env file. ROCK_API is the URL of your Rock instance with /api appended to the end. ROCK_TOKEN is the REST key of an admin user. You can get this info on your Rock instance from "Admin Tools" > "Apollos Dashboard" after you've installed the Apollos Plugin.
Now simply start the server
yarn start
We use Heroku by default because it's free and easy to get started. If you'd like to use another platform to host your API, you can skip this section.
brew install heroku/brew/heroku
heroku login
Create your app on Heroku
heroku create APP_NAME [-t OPTIONAL_TEAM]
Add your config variables to the remote application
heroku config:set ROCK_API=<url> ROCK_TOKEN=<token>
We deploy through the Github workflow. You need to set three new Github secrets in your new repository:
HEROKU_API_KEY: This comes from your Heroku account dashboard and is used to uploadHEROKU_APP_NAME: This is the Heroku app name from above when you created the serverAPP_DATA_URL: The URL of your server. You can get this by runningheroku infoand using "Web URL"
Simply commit to master and push or re-run the action if you haven't made any changes yet. Once the API Deploy action is finished, you should be able to open up the app in the browser
heroku open
To get started with different API integrations, check out our docs!
This will outline the steps required to get your Android and iOS apps up and running. You will need a functioning production API from the previous section before moving forward.
Rename your project, no spaces!
cd apolloschurchapp
npx react-native-rename "<ChurchName>"
Add new icons and splash screen. For customization, see react-native-make. Icons should be 1024 jpgs and splash should be 3000h transparent png.
yarn icons icon-ios.png --platform ios
yarn icons icon-android.jpg --platform android
yarn splash splash.png
Install dependencies and start the server and bundler
cd ..
yarn
yarn start
Couple final steps you'll need to get the app booted in development mode.
For iOS, you will need to choose a new app identifier and clear out certificates to boot in Development mode. Set the app identifier in the Apple Developer dashboard
Use Xcode to edit the settings:
Change the display name of the app
Now run the command to start the simulator in a separate tab:
yarn ios
Android uses Google Maps for its map service so you will need to register a Google Maps API Key. Once you have that, define it in your .env file:
GOOGLE_MAPS_API_KEY=<KEY>
Change the app-name in apolloschurchapp/android/app/src/main/res/values/strings.xml
<string name="app_name">NEW NAME</string>
Then start the app on the default installed emulator in a separate tab.
yarn android
The last thing you'll want to do to make sure you don't lose your important keys and credentials is encrypt them and add them to the repo. Copy the .env file in both API and app directories to a new file, .env.shared. Then from the root directory, run the encryption command.
yarn secrets -e <password>
Make sure to remember that password as we'll use it later for automatic Android deploys. Add it to Github as a secret
ENCRYPTION_PASSWORD=<password>
We use Fastlane through Github Actions to manage certificates and build uploads. This will walk you through everything you need to get set up with automated deployments.
First thing we'll do is configure the certificates. Change the following values in the Matchfile:
git_url: This is the private repo you are going to store the certificates
app_identifier: The App ID you chose for your app in the Apple Developer Dashboard
username: Admin level Apple Developer account, used to manage certificates and profiles
You'll need to create a personal access token in Github and use that to authenticate to your certificates repo. Once you have the token, you'll need to encode it to base64.
python -c "import base64;print(base64.b64encode('<github username>:<token>'))"
Add the encoded token to your .env file
MATCH_BASIC_GIT_AUTHORIZATION=<token>
NOTE: If this is a new app, you will need to add at least one device to the developer portal. Easiest way is to have Xcode do it by turning off and on "Automatic Code Signing" with an iPhone plugged in.
Inside the app directory run match to configure the certificates
bundle exec fastlane match development
bundle exec fastlane match appstore
Match will ask you to enter a password. Go ahead and add it to your .env file. You'll need to decrypt on the CI for automatic deploys.
MATCH_PASSWORD=<password>
Next, the Fastfile, change all instances of apolloshchurchapp and apolloschurchappprod to your projects condensed name. It's probably Whatever name you defined earlier with no spaces. You can be sure from ios/<name>.xcodeproj
Lastly, in the Appfile change, the following variables:
app_identifier- same ID you specified in theMatchfileapple_id- The Apple ID you want responsible for uploads, must be at least "App Manager" levelitc_team_id- App Store Connect Team IDteam_id- Apple Developer Portal Team ID
Test the deployment:
bundle exec fastlane ios deploy
When it asks you choose the "team ID", copy the number and replace the itc_connect_id variable in the Appfile. This will be used by the CI.
Now configure Github Actions for automated deploys. Add MATCH_GIT_BASIC_AUTHORIZATION and MATCH_PASSWORD (the one I told you to remember) as repo secrets.
First, you'll need to have the Developer account owner generate an upload key.json file
Drop that file here: apolloschurchapp/android/key.json
You can validate the upload key with this command
fastlane run validate_play_store_json_key json_key:/path/to/your/downloaded/file.json
Next, you'll need to generate a new signing key. Keep the passwords it asks you for.
keytool -genkey -v -keystore apollos.keystore -alias apollos -keyalg RSA -keysize 2048 -validity 10000
Drop the keystore file here: apolloschurchapp/android/app/apollos.keystore
NOTE: You may also want to save this keystore and credentials somewhere safe outside this repo, it's the only keystore you can ever use for this app and if you lose it, it's very difficult to get a new one.
Now just load these environment variables in your local .env file and as Github secrets for the CI
KEYSTORE_FILE=apollos.keystore
KEYSTORE_PASSWORD=<keystore password>
KEY_ALIAS=apollos
KEY_PASSWORD=<alias password>
Change the package_name variable in the Appfile to your new bundle ID. You can get this from your android/app/build.gradle file.
You will need to upload the bundle manually the first time, Fastlane can't do it for you. Run the command to create a release build
bundle exec fastlane gradle task:clean project_dir:android
bundle exec fastlane gradle task:bundle build_type:Release project_dir:android
Upload to the store on the internal track
Go through the steps to finish your first release.
Now you're ready to test the deploy
bundle exec fastlane android deploy
Lastly, to get automated deploys working on the CI, re-run the encryption command from a previous step to add the new keystore and upload key to the repo
yarn secrets -e <password>
And add that password as a Github secret ENCRYPTION_PASSWORD