Skip to content

Web based application that builds communities through sharing breakfasts using Node.js, socket.io, Google Maps, Stripe and Algolia APIs.

Notifications You must be signed in to change notification settings

metildachee/breakie

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

breakie - made with love, from next door

breakie is a web based application that builds communities through sharing breakfasts.

What is breakie?

The new generation of workers rarely eat breakfast, especially during the rush hours. On the other hand, many cooking enthusiasts often make too much breakfast and can't finish it alone. What if there was a way to close this gap? breakie hopes to solve this issue by providing a platform for busy bees and cook enthusiast to communicate and share.

Who should use breakie?

Busy bees Cooking enthusiasts
Convenient Meaningful
Delicious Minimal wastage
Cheap Earn ingredient cost
Know your neighbours Know your neighbours

How does it work?

  • Buyers can visit the site to see what's cooking near them, they are interested, they can purchase it with a minimal fee.
  • Cooking enthusiasts can visit the site to share what they're cooking for the day.

Who can do what?

Registered Non-registered
View breakies View breakies
Search breakies Search breakies
View published users View published users
Create breakies
Edit breakies
Delete breakies
Place orders
Cancel orders
Chat to resolve problems

Order life cycle

Tag Description Initiated by
Completed The standard completion of life cycle. This can be initiated by either the buyer or cook enthusiast. Buyer and cook enthusiast
Cancelled Should the buyer be unable to pick up the order, the buyer can cancel the order. This leads to completion of the life cycle as well. This can only be initiated by the buyer. Buyer
Unlisted Should the cook enthusiast unlist any of the items while an order is still open, the order will be labelled as unlisted. Unlisting a breakie will not affect past orders. However, a chat is required to close the life cycle. Cook enthusiast

Mock-ups

See here for more mockups.

Technologies used

Front-end

HTML, CSS, Javascript

Backend

Node.js, Express.js, Multer, MongoDB, mongoose

socket.io

For resolving purchase conflicts between busy bees and cook enthusiasts.

APIs

Google Maps

Used for geocoding, distance matrix, map visualisation.

Breakies are displayed in increasing travel time from user's address. When hovered, the map markers highlights the associated breakies. When clicked, a window appears with the breakies of that cook enthusiast. This can be helpful for buyers who might be more interested in travel time than dishes.

Stripe Checkout

Used for payment.

Algolia

Used for real-time autocomplete and database search.

This allows searching by breakies' name, description, ingredients, cuisine type, cook enthusiast's username, address. Autocompletion also allows for typos and partial words. This can be helpful for potential buyers as there is a single source of entry and little confusion.

References

About

Web based application that builds communities through sharing breakfasts using Node.js, socket.io, Google Maps, Stripe and Algolia APIs.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published