TreeHealth is a mobile-based application that aims to provide homeowners with early notifications or warnings to health risks potentially affecting their trees.
-
Follow this tutorial to download a local copy of the TreeHealth repository.
-
To run the code within the TreeHealth app you must download Node.js to run it's npm commands in the terminal. You can find download instructions here
-
To run the simulator to visualize the app on your local system you will have to install the correct SDKs; based on your operating system. If you are on an iOS machine you will need to have XCode installed, which you can do via the App Store or follow this link. If you are on a windows machine you need to install the Android SDK and Android emulator.
-
Additionally, you will need to download the Expo client which helps to run the simulators. You can do this with the following command in terminal
npm install -g expo-cli
- Once you have done the above and installed are the requirements, you can open the terminal, navigate to the TreeHealth folder, and run the following commands:
npm install
npm start
- The first command will install all the dependencies required by the app and the second command will start the app. After running these commands you should be redirected to the Expo web page where you will want to click "Run iOS Simulator" or "Run Android Simulator" depending on your machine's operating system. You will see a mock phone pop up and the TreeHealth app will begin to load. Also, you can run the app on your phone by scanning the QR code on the web page.
You can now interact with the app as normal.
We use a platform called Firebase, a cloud storage system. When building this app, we used our own personal keys and Firebase set up, however, now that we are handing this off we will provide instructions for your team to set up your own Firebase configuration. We have left our configuration in the application files, however, after following the instructions below you can update that information with your own.
-You can sign into Firebase with your Google account. If you don’t have a Google account, you can create one.This must be a non Northwestern account as Northwestern does not support Firebase usage.
-You will begin by creating a new firebase project. You can follow this tutorial to create the project.
-You will now have to link the Firebase project you created to the app. You can follow this tutorial
Since we are using React Native, sometimes there are discrepancies between functions/packages used for the iOS platform versus the Android platform. This leads to some UI/visual elements changing based on which platform you are using. However, it should never affect the functionality of the app.
Currently there is a warning present within that app that begins with:
Warning: Can't perform a React state update on an unmounted component. This is a no-op, but it indicates a memory leak in your application. To fix, cancel all subscriptions and asynchronous tasks in %s.%s, a useEffect cleanup function
This warning is associated with the camera function, however, it does not interfere with any of the application's functionalities or capabilities. The app still works the same with this warning.
Running
npm audit
will show 9 low severity vulnerabilities associated with the mem and yargs-parser packages that are dependencies for some packages that are outdated (react-native). It is not possible to update these packages at this time because the latest version is not compatible with the functionalities in place for the app.
Running
npm outdated
will show the following packages: react-native current: 0.61.4 react-native-safe-area-context: 1.0.2