Giter Club home page Giter Club logo

cs-411-project's Introduction

๐ŸŒŸ Setting up and launching the project:

The basic stuff:

  • 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 the web/ and functions/ folder.
  • You should be able to ignore the other npm install <library> mentioned below, but those are provided just in case.

Plaid && ChatGPT

  • 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.

Firebase:

  • Install firebase and firebase-tools using npm 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 ๐Ÿ”‘

Launch locally:

  • 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 the functions/ folder to build and update the functions
  • To run the emulator, run firebase emulators:start in web/.

Enjoy! ๐Ÿš€

cs-411-project's People

Contributors

onkr0d avatar steveny21 avatar rajivc avatar ruyiting17 avatar

Watchers

 avatar

cs-411-project's Issues

Tech Stack demo

need to submit a video demo of our basic tech stack + api calls

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.