Setup Guide

Quick Start

This project requires Firebase to run properly. If you do not have firebase tools installed already, run sudo npm i -g firebase-tools and then firebase login to log into your firebase account.

To get started immediately, clone this repository and run the following commands from the root of this repo to install all required packages and run the project locally:

# installs all required packages
$ npm run install

# runs frontend locally
$ npm run emulate:frontend

# runs backend locally (do this in a separate shell)
$ npm run emulate:backend

Secret Files

Several files for this project contain sensitive information and therefore cannot be included in the public repository. To gain access to these files, please contact the current BRH software lead (their name should be listed in the README.md file). Once received, these files should be placed in the appropriate directory as detailed below

Filename	Purpose	Directory
service-account.json	Contains the configurations needed to access the live Firebase project as an admin. Note that this file is not needed to run the Firebase emulator locally.	backend/functions

Running Locally

You can run the Next.js development server using either of the following commands:

# From the root directory
$ npm run emulate:frontend

# From /frontend
$ npm run dev

You can run the local firebase emulators using either of the following commands:

# From the root directory
$ npm run emulate:backend

# From /backend/functions
$ npm run emulate