Caffeine Dashboard

Technical Documentation

Getting Started

1. Clone repo

git clone https://github.com/engagingnewsproject/caffeine-app.git

2. Install Packages

From the root of the project install dependencies by running:

yarn

3. Add Firebase configuration

In order to be authenticated with the Firebase Project you must have the .env file (which contains the Firebase credentials) at the root of your project. To get the contents of the .env file reach out to the project lead (currently Luke).

4. Install Firebase Emulator

Install Firebase Tools by running:

curl -sL firebase.tools | bash

• Install, configure and integrate Local Emulator Suite

5. Start dev server

To boot up the development server and Firebase Emulator run:

yarn dev

This command will boot up the Firebase Emulator UI and the NextJS server. Look over your terminal output and click the Emulator links (Emulator UI) and localhost link.

Emulator Users

The emulator has 3 user accounts already set up. You can log in with any of them. Each login has different permissions so the layout will change based on who you are logged in with.

User:

• email: [email protected]
• pass: devPassword

Agency user:

• email: [email protected]
• pass: devPassword

Admin user:

• email: [email protected]
• pass: devPassword

You can also sign up with totally different info (email, name, city, state ect.). When you sign up a authorization link will print out in your terminal. You will need to click that link to verify. After you click the link you can close the window that open's (its only for verification) and return to your localhost window to log in.

Firebase Functions

If you make changes to the functions/index.js Firebase functions you will need to deploy your changes:

firebase deploy --only functions