- Clone the repository
- Install Firebase CLI
- Install Bun.js
, which is used in place of npm (because it's way faster)
- Install the required dependencies with
npm install
in theweb/
andfunctions/
folder. - You should be able to ignore the other
npm install <library>
mentioned below, but those are provided just in case.
- Install openai API with
npm install --save openai
. - Get API keys from your OpenAI Project, which can be created here.
- Install Plaid API with
npm install plaid
. - Get API keys from your Plaid Project, which can be created here.
- Install
firebase
andfirebase-tools
usingnpm install -g <library_name>
. - Run
firebase login
to log in to your Firebase account. - Create a new project in the Firebase Console.
- Set up all necessary services (Firestore, Functions, Hosting, Auth, AppCheck) on the Firebase Console.
- Make sure you populate all
.example.env
files with the legitimate credentials ๐
- Firebase provides an emulator suite, but support for our tooling (Next.js) is experimental
โ ๏ธ :- We must run the emulator from the
web/
folder - We must run
bun lint --fix && bun run build
in thefunctions/
folder to build and update the functions
- We must run the emulator from the
- To run the emulator, run
firebase emulators:start
inweb/
.
Enjoy! ๐