Skip to content

Latest commit

 

History

History
53 lines (38 loc) · 2.22 KB

README.md

File metadata and controls

53 lines (38 loc) · 2.22 KB
Raw

off-campus-touring

A touring app.

Technologies

This app is built with:

  • React Native
  • Firebase

Folder structure

  • Screens/Pages/Shells should go in the in the screens folder
  • JSX that is smaller than screens should go in the components folder
  • data.js is for the dumb data. This will make is easier to transfer to a backend.

Getting the App Running

Before doing these steps, make sure your environment is setup. Please follow the react-native-cli version of this tutorial: https://reactnative.dev/docs/environment-setup

Installing application (one time unless you need switch branches)

  1. Clone the project.
  2. cd off-campus-touring
  3. npm install
  4. Assuming you want to run the iOS simulator, cd ios && pod install && cd ../

Building and running the app (requires 2 terminals)

  1. npx react-native start
  2. In another terminal, npx react-native run-ios.

firebase keys

Please download and place the following keys from firebase:

  • /android/app/google-services.json
  • /ios/GoogleService-Info.plist

.gitignore will ignore these files when adding to a commit. (Will have to clean if these get pushed)

Branch General Info

Main Branches

Master - Staging - All feature branches

Master - stable version

Staging - could be called the develop branch, this is where you want do most of your branching to build new features. Once you finish the feature, you can merge it back into the develop branch (using the pull request on github) and then you should delete your feature branch (on github). Why?

Firebase connection:

In order for easy integration with react-native, we are using rnfirebase library.

Learn about Async Storage (will implement this in future)

https://react-native-async-storage.github.io/async-storage/docs/install/

Demo

2022-06-02.15-00-30.mp4