# iSeaTree-React-PrototypeThis is the repository for iSeaTree, a mobile app which observers can use to collect data for the iSeaTree project.
The iSeaTree project is an open source project for building the react-native iSeaTree app (available in iOS and Android). Links to our current releases can be found on our TreeMama.org webpage. This project utilizes the USDA's US Forest Service iTree API to calculate the individual CO2/Stormwater tree benefits of trees. iSeaTree is an educational tool, and was founded by Treemama.org with the belief that "kids can do more for then environment then just study it - they can participate in conserving it!".
We follow a relaxed version of the Git Flow workflow.
The develop branch is the default branch. The develop branch is always ready to be released. It contains only
completed features and completed bugfixes. Do not commit directly to develop; use pull requests and merges from
feature branches instead.
All feature and bugfix work is done in feature branches, branching from develop, and named with the pattern feature/<short descriptive name>.
Code reviews are not required, but pull requests are required. You can approve your own PR, or you can tag another team
member to review it if you like.
Use descriptive names for feature branches. You can use the #234 syntax in the comments to link to a particular issue or pull request. But please name your branches
descriptively, so that another human can look at the branch name and understand what it's about.
The release branch is where all releases are built from. You will not touch the release branch at all unless you are deploying a release
to an app store. Update the version number and build number directly
in the release branch, just before release. Do not commit directly to release, except for edits of of the files that control the version number and build number.
Merge all other changes to release from develop.
git checkout developgit pull (to make sure you're starting with the newest code).git checkout -b feature/frobishizer-bug (just an example, we don't have a frobishizer in this project...yet).git push periodically, to keep the Github repository updated with your work. The first time you push, you'll have to use git push --set-upstream origin feature/frobishizer-bug, but the Github command line will remind you of this.develop) branch:
git pushgit checkout develop (this retrieves work committed to develop from other branches while you were building the frobishizer).git pullgit checkout feature/mybranchgit merge develop (this catches your feature branch up with the new work in develop).git pushfeature/mybranch to develop, on the Github repository web page.Please keep these in sync for Android and iOS.
Android version and build number are controlled by android/app/release/output-metadata.json.
iOS version and build number are controlled by ios/iSeaTree/Info.plist. Info.plist is an XML file. You can edit it with a text editor, no need for Xcode.
This project uses [react-native-cli]. Here is a guide how to get started with react-native-cli. react-native-cli is contains the actual React Native framework code and is installed locally into your project, react-native-cli project is said to be a pure React Native app, since none of the native code is hidden away from the developer. a development tool that runs interpreted JavaScript on your mobile device, in debug mode. react-native-cli project has native code for Android and iOS, so, you can perform any release related operation for Android and iOS, by using Android Studio and Xcode respectively.
You need Xcode or Android Studio to work on this project. It doesn't matter which one you use. You'll be working on the JavaScript code in whatever text editor you like (many of us use VSCode). The IDE is used only to wrap the JavaScript and package it for Android or iOS devices.
npm install --global yarn, or perhaps sudo npm install --global yarn.npm install –g react-native-cli, or perhaps sudo npm install –g react-native-cli.This is a one-time setup for each computer you'll do Yarn/react-native-cli development on.
Although we no longer use the Expo platform, there are still some Expo-prefixed node modules in use. This is not an oversight.
From the project's root directory run:
yarn installThis sets up Yarn for the iSeaTree project directory.
Note: you'll probably have to run yarn install after a git pull, if the updated code has added React libraries or changed library versions.
There are 3 critical files NOT CHECKED in that you will need (as a developer) to interact with the iTree API & the backend firebase database(s).
To get these files - contact an iSeaTree project administrator.
The 3 files are:
envVariables.ts file holds all secret keys (api keys etc) associated with the iTree API. It is located in the project root level (same as this README) \ios\iSeaTree\GoogleService-Info.plist file (for ios developers. Add this to your '\ios\iSeaTree\' folder).\android\app\google-services.json file (for android developers. Add this to your '\android\app\' folder)../verify-checksums.shwill check to see whether you have envVariables.ts in the right
place, and whether it is the current production or development version
or something else.
For project administrators: when you update envVariables.ts
shasum -a 512 envVariables.ts > checksum-prod.txt and commit checksum-prod.txt to the repository.shasum -a 512 envVariables.ts > checksum-dev.txt and commit checksum-dev.txt to the repository.For Google map functionality we have to add "google api key" in the below file
app/src/main/AndroidManifest.xmlcom.google.android.geo.API_KEY meta tag.In your terminal window, change directories to the project root. Then
open /Applications/Xcode.app/Contents/Developer/Applications/Simulator.app
npx react-native run-iosnpx react-native run-androidThis command launches a metroServer on your computer and loads the JavaScript source code for the project.
Possible failure modess:
error Failed to launch the app on simulator, An error was encountered processing the command (domain=com.apple.CoreSimulator.SimError, code=405):To fix it, launch the iOS Simulator, choose File -> New Simulator from the menu bar, wait for it to finish booting, and then run the npx command again.
metroServer has failed. Kill the metroServer
and run the npx command again.You'll want to use a real mobile device if you're doing anything with the camera.
To create a standalone native build that we can submit to the iOS App Store, we need to create a cryptographically signed .xcarchive file using Xcode. That procedure
is described in the iOS document too.
when you run npx react-native run-android it run the application on all devices which enabled debug mode.
To obtain a standalone native build, we have android folder that contain native code for our application,
by open it on Android Studio, we can make signed APK.
This project has configured Eslint with recommended typescript and react rules.
Do not change version or build number yourself. Follow the procedures documented in the App store release instructions.
Version and build numbers must be changed simultaneously for the Android and iOS versions. The version update must be a single commit,
performed in the release branch, and is the only operation in that commit.
Prior to September 2021, the project used expo-cli package. In order to add certain features, including our AR-tool and the Jest test framework we removed expo with the work done in Issue #299. This made the project react-native only (and fundamentally changed how we build and test our source code).
firebase dependency with @react-native-firebaseexpo-camera dependency with react-native-camerareact-native-unimodules
firebase dependency with @react-native-firebase?
firebase is not recognised by the react-nativeexpo-camera dependency with react-native-camera?react-native-unimodules?