Skip to content

uwo-openhouse/openhouse-app

Repository files navigation

WesternU Open House App

WesternU Open House

Build Create Release

Description

Mobile app for Western U's Open House Event. The app focuses on displaying current events happening for the open house that is currently active. The app allows users to 'save' events to their planner and view their time, location and descriptions of the event from the app.

Contents

Getting Started

Requirements

  • NodeJS
  • Yarn
  • Git
  • Android Studio
  • IOS simulator

Setup

Setup the openhouse-backend.

Setup the openhouse-admin-ui.

Create two google maps api keys with the one with the maps SDK for Android enabled and the other with the maps SDK for IOS enabled.

Replace GOOGLE_MAPS_API_KEY_CHANGE_ME in the app.json with your keys.

Setting Up Environment Variables

  1. Create a file called '.env.development' in the root directory (same as the '.env' file)
  2. Add the line BACKEND_URL={ENDPOINT_URL} and set the ENDPOINT_URL to the endpoint you will be testing with
  3. Close expo and run exp r -c in the terminal to clear the cache

Running the Project

  1. Clone the project. (you will need Node.JS)

  2. Install Libs: yarn

  3. Run with: expo start

  4. To test:

    i) Download the EXPO app and scan the QR code

    ii) If on windows download an android emulator (suggested: Android Virtual Device (AVD)) and click run on android emulator.

    iii) The iOS version of the app can be tested using a machine running MacOS. Install Xcode for the iOS simulators and Android Studio for Android.

Creating a Release

Make sure you increment the versions of version, versionCode and buildNumber in the app.json.

To create a release push a tag matching the format v* and release with automatically be created and the built IOS app will be uploaded to App Store Connect.

Getting to know React 101

Useful resource for getting to understand basic concepts within react native. (Note: this is using react native cli to get started but we are using expo.) http://www.reactnativeexpress.com/

Expo provides a lot of useful guides: https://docs.expo.io/versions/latest/

Resources

Contributions

All contributors please be sure to add yourselves to the list at contributors.js