Coffee and Code Philly

Getting Started

To begin working with this project, follow the steps below to set up your local development environment.

Install Project Dependencies

Run the following command to install the project's dependencies:

npm install

If you encounter an error due to not having npm installed, make sure to install Node.js.

Configure the Backend

1. Authenticate with Firebase

The backend of this project is hosted on Firebase. To duplicate the application in your local environment, you need to authenticate with Firebase. a. Install the Firebase CLI

You can install the Firebase CLI with the following command:

npm install --global firebase-functions firebase-admin firebase-tools firebase

b. Login to Firebase

Authenticate with Firebase by running:

firebase login

If you cannot access our organization's Firebase credentials, request them from a project maintainer. The recommended way is to create an issue with the title Firebase Access Request. Include your name, email, and the reason for requesting access. If approved, a maintainer will provide you with the necessary credentials.

2. Create .env file and input Firebase credentials a. Create .env file

Navigate to the root directory of the project and execute the following command:

touch .env

b. Paste in env variables

Paste the following text into your new .env file:

REACT_APP_FIREBASE_API_KEY=
REACT_APP_FIREBASE_AUTH_DOMAIN=
REACT_APP_FIREBASE_DATABASE_URL=
REACT_APP_FIREBASE_PROJECT_ID=
REACT_APP_FIREBASE_STORAGE_BUCKET=
REACT_APP_FIREBASE_MESSAGING_SENDER_ID=
REACT_APP_FIREBASE_APP_ID=
REACT_APP_FIREBASE_MEASUREMENT_ID=

c. Retrieve Firebase Config Variables and Input in .env

Navigate to https://firebase.google.com/. Click Go to console on the top right of the page. Select the "coffee-and-code-philly-website" project. Navigate to the project settings and scroll down to the "Your apps" section. Copy the items from the firebase config for the coffee_and_code_dotcom webapp to their associated variables in the .env file. This step is required to successfully run your application locally.

3. Select the Firebase Project

Set the correct active Firebase project for your working directory by running and selecting coffee-and-code-philly-website:

firebase use --add

c. Run the Backend Locally

To run the project in your local environment, execute the following command:

firebase serve

Launch the Frontend

To launch the Frontend, ensure you have first installed the necessary dependencies, then run the following command:

npm start

Optional: Run Firebase Cloud Functions in a Test Environment

If you would like to run Firebase Cloud Functions locally in a test environment, refer to this document.

For a quick start, you can run the following command:

firebase emulators:start

To verify that a cloud function is working properly, visit the following URL (replace <function_name_here> with the actual function name):

http://127.0.0.1:5001/coffee-and-code-philly-w-c03af/us-central1/<function_name_here>

We have a helloWorld cloud function that you can use to verify your setup:

http://127.0.0.1:5001/coffee-and-code-philly-w-c03af/us-central1/helloWorld