Code Monkey home page Code Monkey logo

chowbread-backend's Introduction

ChowBread

This is a fullstack web application created for General Assembly’s Software Engineering Immersive Program. This is the backend repository of the application. The frontend repository can be found here.

ChowBread is a web application built for users to track their food expenses. After registering for an account, users can then add food expenses in ChowBread to a clearer visualisation on how much and where the money was spent on. There is also an in-built GST calculator which users can use to find out their share of bill when dining out with friends.

Technical Used

These are the cool friends that helped made my application possible

Frontend:

Backend:

Database:

Installation Instructions

All the necessary libraries needed for the web application to run are found in the package.json file provided. Install them using npm install if you are using node package manager.

If you wish to run the backend server with your own database, you will need to link your database to the server for it to run properly.

Development Process

User Stories

Firstly, the important features of the web application were determined having these user stories in mind:

User Story 1: As someone who goes out with my friends often I need a way to figure out a way to calculate my portion when splitting bills.
User Story 2: As someone who is concerns about food budgetting I need a way to track how much I spend for food and analyse how I can improve on my food budget.

From there, these are some of the main features that ChowBread should have:

  • A calculator that provides a quick and easy way for users to find out the total amount that includes GST and service charge
  • A feature that allows users to add new entry for food expenses
  • A chart that provides a visualisation on a user's spending habits

Wireframes

Simple wireframes were then developed to accommodate to all the features the application should have:

Calculator Page Wireframe

Food Tracking Feature Wireframe

Server Routes

A backend server was created to help with authenticating users and retrieve all the data necessary to be displayed on the frontend. With the main features in mind, below are routes we came up with for the server:

Server Routes

Data Structure

A relational database was created to store important data such as user data and expense data for the application, and how the different pieces of information are related can be found in the entity relationship diagram below:

ERD

Future Development

  • Add a function that allows user to filter for expenses that they require, such as filtering for a particular month or filtering just expenses spent on eating out.

chowbread-backend's People

Contributors

charmainelhm avatar

Watchers

 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.