Git Product home page Git Product logo

splitwise3's Introduction

Hi, welcome to SplitWise, a web app that allows you to split bills between friends

About the repo:

The repo at the moment only contains a front-end app built using vanila React and Material UI.

The repo tries to follow monorepo structure. Most of the code will be in src/ and other configurations or Docker-related stuff will be in the root folder.

Features and roadmap (to be added)

How to run this locally:

  • npm install at root
  • After installing, src/api/src/firebase/configs.ts will be created (this is where you add your Firebase credentials) which looks like this
const adminCredentials = {
  // TODO: add firebase admin credentials here, you also need to convert JSON file to Javascript Object
};
const firebaseCredentials = {
  // TODO: add firebase SDK credentials here
};
export { adminCredentials, firebaseCredentials };

Next, you must have:

  • Firebase SDK credentials
  • Firebase Admin or Service Account credentials

Firebase SDK credentials:

You can follow this official guide: https://firebase.google.com/docs/web/setup

  • Basically, create a new project in Firebase console and get the credentials needed. As long as, when going to project settings, if you have this type of credentials => you're Gucci

Screenshot 2022-09-08 235916

  • Add it to firebaseCredentials in src/api/src/firebase/configs.ts

Firebase Admin or Service Account credentials:

  • Head to service account tab in Firebase console project setting, click Generate new key

image

  • It'll download a .json file => copy the content of the file and convert it to JS Object (using an online tool is probably the easiest way)
  • Add it to adminCredentials in src/api/src/firebase/configs.ts

How to run this locally (continue):

Normal way:

  • cd src/api
  • npm run dev
  • cd ../web
  • npm run start

Docker:

You need Docker and docker-compose in your system

  • npm run services:up

For fun:

Join my expense:

  • expenseId: 22ia71590l7tx7019
  • password: l7tx701a

To communicate easier, please join Discord: https://discord.gg/fz7RtW3AVM

splitwise3's People

Contributors

tueenguyen avatar kimjust6 avatar mqnguyen5 avatar hslkalp avatar hayatdurgut avatar

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.