https://github.com/isubasinghe/info30005-backend

https://github.com/isubasinghe/info30005-backend

Last synced: 9 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/isubasinghe/info30005-backend
• Owner: isubasinghe
• Created: 2019-03-12T20:30:31.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2022-12-22T10:53:31.000Z (almost 2 years ago)
• Last Synced: 2024-10-12T12:44:43.492Z (25 days ago)
• Language: JavaScript
• Size: 10.1 MB
• Stars: 0
• Watchers: 4
• Forks: 0
• Open Issues: 28
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Foodspan Backend Repository

## Functionalities implemented

## User Authentication/Account Creation

This particular functionality refers to how people will use our website. All users must have a registered account. This can be broken down further into a few sub-fucntionalities.

### User Sign Up

Users can sign up through entering their name, email address, a password and an address. The backend validates the submitted forms, ensuring the email is of valid format and the address is a valid location. This functionality ensures that people can use the core features of our website and provide a customised experience for individual users.

### User verification

Post sign up, the user will have an email sent to their account to verify their email. Upon clicking this email, the user becomes validated and able to sign in and use foodspan. This ensures that users can ensure malicious users do not create a fake account in their name and manipulate their data.

### User Sign in

User's can login using their email and password to access their own kitchen/account items. This returns a JWT token to ensure that once a user is logged in, the token is used to retrieve information from the database in a secure manner (only the logged in user can access the database).

## Viewing all items

This allows the user to make a call to the database and return all the current items in their inventory. This is useful for users to know exactly what they have in their pantries at home, without physically having to be at their home kitchen.

## Adding items

User's are able to add an item, through sending the item name, category (from a defined group), the quantity, units and date of expiry. This will allow users to ensure their is a digital copy of their items at home wich will be later used for tracking items.

## Updating item quantities

User's can update the quantity of items through either changing the item to the desired quantity, or using the quick increase ande decrease functions which decrement it by 1. Depending on the quantity, the system will simply update or remove the item altogether. This allows users to keep track of how much item they have and adjust when they consume the items.

## Recipe Generation

A user's items is checked and in order of expiry, a list of recipes are generated. In the case of no recipes, it will generate for the one ingredient expiring soon. This provides users with a way to use their items that will be expiring soon

## Marketplace search

User's can check other user's items (and search for an item they want or look at items nearby them) they have to offer and click a button to send an email to the owner; allowing a trade to potentially occur. This allows user's to trade items and get rid of items they may not be able to use before the expiry.