bootcamp-group5 / simply-unused

This application will help you keep track of perishable food items!

🥗 Welcome to Simply Unused! 🥗

With Simply Unused you will never have to worry about expiry dates again!

🍎 Table of Contents 🍎

• Contributors
• Licenses
• Overview
• Features
• Technologies
• Functionality
• Presentation
• Status
• Texting
• Questions
• Credits
• Webpage

🍽 Contributors 🍽

Shanshan(Tina) Xu	Austin Dudzic	Ali Taghva	Ojashri Basnyat	Esteban Romero
Shanshan's (Tina) Github	Austin's Github	Ali's Github	Ojashri's Github	Esteban's Github

📃 License 📃

🍝 Overview 🍝

Welcome to Simply Unused! This is a web application to keep track of all of your groceries and household items! With technology on the rise we have created a way to have one less thing to worry about. When buying groceries one of the biggest considerations is the expiration date of the items you are purchasing. With simly unused we have elimated all need for concern! We do the remebering for you! Never again will you the user have to do the sniff test on that questionable milk in the back of the fridge. WIth simply unsued we track the expiry dates for you! With our user friendly dashboard keeping track of your pantry items has never been easier.

🥩 Features 🥩

This webpage uses user input to track items that they input into our system. We have a timer that will run in accordance to the expiration date and will visibly show when items are close to expiring. After being prompted to login the user will be brought to our dashboard where they will have the option to use the side bar that lists common food items in an accordian stlye drop down window. If they so choose they can also input the information manually a picture of this food item will populate the homepage, and they will then have to input the quantity and expiration date. We take care of the rest.

🍲 Technologies 🍲

Styled with

• Bootstrap Font Awesome
• Bootstrap Stackpath
• Anime.js
• Handlebar JS

Backend

• Json
• Sequelize (mysql2) for the database
• Node.js

🌮 Functionality 🌮

🍭 Status 🍭

• We are currently testing the possibiltys of barcode reading and picture recognition software.
• Lastly we are going to give recipe alerts to the user, these alerts will be based on the items in their pantry and recommend easy to make dishes with their food products.
• We beleive this will help reduce waste and also save the user money, this will be a paid feature.

🍣 Presentation 🍣

Simply-Unused.pptx

🤳 Texting 🤳

We have introduced texting notifications to our website! This will update the user via text when their food is close to expiration! Although we are currently limited to the free version of this technology as traffic starts to increase we will move int the paid version and unlock this feature to the general public! If you would like to add your number to the texting list please contact us at [email protected] !

🙋‍ Questions / Contributions 🙋‍

Any questions or contributions can be sent to our group email at [email protected] !

A special thank you to our teachers, and to the technologies we used. A special thank you to trillio for a free membership to include our texting functionality!

🍱 Webpage 🍱

Simply Unused Link

Simply Unused Github Page

simply-unused's Issues

Intergration

Integration of the backend code once the front end has been completed.
Use the Id and classes to create functionality in the website through JS
after inspecting the code pull requests into development and eventually into main.
The use of handlebar js, bootstrap, HTML, and CSS must all work together in harmony

Barcode reader

Once the MVP is complete it would be nice to implement a barcode reading function
This would allow the user even more ease at tracking their items

New task

This is a new task!

Database Creation and Management

Must use MySQL and the Sequelize ORM for the database

Application MVC file structure

Create MVC file structure.

Scheduling and giving out responsibilities.

Come up with a structure for how we will succeed as a group and divide up the project.
Schedule where we would like to be on what days.
check off tasks.

Styling

Css implementation of the 4 HTML pages.
as per the requirements "have a polished UI"

Heroku

A slight issue of the PPPPPPPPPublic folder was resolved today, huge learning moment for all of us as we struggled to rename a folder in the main directory. We were able to clear this issue and deploy with Heroku

screen shot

su.mp4

Simply-Unused.pptx

Template engine

Must use a template engine such as Handlebar.js

NPM Nodemailer

Create the NPM Database

Application Libraries tracking.

Must use at least one new library, package, or technology that we haven’t discussed

API Routing

Must have both "Get" and "post" routes

Documentation

Create the documentation for submission
Create issues for this project on the project board.
Create a PowerPoint presentation
Create a readMe

Favicon

Create a favicon or find one of google, to add more flair to the webpage.

Make main secure

Change the pull requests to be restricted on main after Wednesday

Front End

Create a user interface that is easy to use.

Has a drop-down window on the left with basic categories that populate generic food product icons (IE, fruit; displays apple banana)

The Center of the page has a card with an input, a picture, an add button a quantity, and an expiry date.

The right side of the page will have a history of the last items input,

The second page will have all the items in the inventory and give the user the ability to sort by name, expiry date etc.

Finishing touches

Finish up the project for submission on Sunday!

Add to your own profile website.

Deploration

Must be deployed with Heroku

Powerpoint

The powerpoint presentation needs to be completed before March 23rd so that we can review and prepare for Wednesday's presentation.

API Calls

Find and select API's for the following,
Barcode Reading
Picture recognition
Perishable Items alerts
Recipe finder with ingredients

Readme

A proper readme must be created to support our repository's professionalism.

Description of how the application works and what technologies were used.
This includes photos and links to each creator's GitHub.
screenshot of the application
quick gif of the app working
links to the live website.