SHPEUCF / shpeucfapp

SHPE UCF Mobile Application

SHPE @ UCF Mobile App Development

An open-source application used to aid in the organization of SHPE @ UCF and simplify everyone's jobs.

Getting Started

Follow these instructions to get you started in contributing to the SHPE UCF app.

Contents

• Pre-requisites
  • Windows
  • MacOS
• Installation
• Running
• Contributing
• About
• Common errors

Pre-requisites

What do I need to start contributing to the SHPE app?

A more detailed summary can be found here.

Windows

Git

For version control; this is how we manage all the files on our app and how you are able to read this now on GitHub. You can download the latest version (2.31.0 as of March 2021) here.

Node

The runtime we use to build the app. Download the latest stable version (14.16.0 as of March 2021) here.

Java 8 JDK

Used to build and emulate the app on Android Studio.

• To check your version open command prompt (not WSL) and run java -version, making sure that it is Java 8. If you don't have this version, you can download it here.
• You will need to add JAVA_HOME as an environment variable, to tell Windows which version of Java you want to use. For a guide on how to do that, go here.

Python 3

Since the building system for React Native uses Python, you will need to install it. Go here and download the latest stable version (3.9.2 as of March 2021).

Android Studio

To build and test the app you can:

1. Run on a physical Android device
2. Run on Android Studio.
   a. Download Android Studio.
   b. Download the AVD (Android Virtual Device) inside Android Studio. Go here for an in-depth guide.

MacOS

Git

For version control; this is how we manage all the files on our app and how you are able to read this now on GitHub. You can download the latest version (2.31.0 as of March 2021) here.

Node

The runtime we use to build the app.

• Download HomeBrew here.
• On your terminal, write brew install node@12.

Xcode

• You can only download this through the App Store, version 12+.
• If you want to use a physical device follow this.
• Make sure that you are signed in to your Apple account and that your account is a developer account.

Java 8 JDK (Optional)

Used to build and emulate the app on Android Studio, if you don't want to use XCode (or you want to use both), or want to see how the app looks on Android.

• To check your version open terminal and run java -version, making sure that it is Java 8. If you don't have this version, you can download it here.
• You will need to add JAVA_HOME. For a guide on how to do that, go here.

Android Studio (Optional)

To build and test the app you can:

1. Run on a physical Android device
2. Run on Android Studio.
   a. Download Android Studio.
   b. Download the Android Virtual Device (AVD) inside Android Studio. Go here for an in-depth guide.

Installation

Getting your development environment running...

1. (Optional) Fork the repository (if you plan on contributing to the app).
2. Open command prompt/terminal and navigate to the directory you want to download the shpeucf repository, preferably the Desktop.
3. Clone the original (or forked) repository. Note that this will create the folder shpeucfapp in the directory you are currently in.

git clone https://github.com/SHPEUCF/shpeucfapp.git

4. Navigate inside the cloned repository.

cd shpeucfapp

5. Install the dependencies used in this project using the node package manager.

npm install

Running

Android

• Open Android Studio and run the Android emulator.
• Open the terminal/command prompt, navigate to the cloned repository (shpeucfapp), and type npx react-native run-android or npm run android.

iOS

• Open the terminal, navigate to the cloned repository (shpeucfapp), and type npx react-native run-ios or npm run ios.

Contributing

For contributing to this project, please check out contributing and the contribution guidelines.

About

Built with

• React Native
• Node

Authors

• Luis Benavides, initial work
• Haniel Diaz, continued work
• Steven Perdomo, continued work
• Idel Martinez, continued work

...and our contributors who participated in this project.

License
This project is licensed under the MIT License. See the LICENSE file for details.

Common errors

JAVA_HOME missing

• MacOS
• Windows

ANDROID_HOME missing

• MacOS(user2993582)
• Windows(Hoque MD Zahidul)

Print: Entry, ":CFBundleIdentifier", Does Not Exist

1. Open the project on Xcode; that is, open "shpeucfapp/ios/shpeucfapp.xcodeproj".
2. In Xcode, File -> Workspace setting.
3. Change Build System to Legacy Build System and click "OK".
4. Follow these instructions:

5. In Xcode, Product -> Clean.
6. In Xcode, Click on the project folder on the left side-bar.

7. Make sure there are no errors by selecting a team and changing the bundle identifier, if it's giving you an error.
8. Close Xcode and try running the simulator by typing react-native run-ios on your terminal (while inside the project folder).
9. If step 6 doesn't work then try running react-native run-ios at least 2 more times.