Skip to content

Latest commit

 

History

History
36 lines (29 loc) · 1.59 KB

CONTRIBUTING.md

File metadata and controls

36 lines (29 loc) · 1.59 KB
Raw

Setup for contributors

Homebrew

Instal homebrew and run the following command:

brew bundle

This command will need to be re-run everytime Brewfile changes (almost never)

Firebase

Access to a Firebase project is required. You can create one for youself in the firebase console. Follow the instructions to setup a project and download the GoogleService-Info.plist. You'll need to place it in one of the following directories, depending on the scheme that you plan to run:

  • Friendly Competitions/Firebase/Debug/
  • Friendly Competitions/Firebase/Release/

The app uses the following firebase services:

Authentication

Manages user authentication. Users need to be signed in to access any & all features

  • Apple
  • Email

Firestore

Stores all user & competition data

Functions

Sends notifications, computes competition scores, cleans up old data.

To deploy this project's functions, run the following commands:

cd firebase/functions
npm install
npm run-script deploy

Note: To deploy functions, this service requires the Blaze plan. You can also explore emulating functions instead of upgrading to the Blaze plan, or disable it's usage in the iOS client.

Storage

Stores images, nothing else for now