Skip to content

A WebApp that allow users to make good coffee consistently by following V60 coffee brewing recipes step by step with a timer

Notifications You must be signed in to change notification settings

KenHo95/brew-mate

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

56 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

☕️ Brew Mate

❓ Overview

An app with a time-based step-by-step V60 brewing instructions display and timer function.

Instructions transition

📚 What we learnt

  • To build a React app with class-based components.
  • To leverage third-party library react-countdown-circle-timer to provide visual feedback to users along with the V60 recipe instructions
  • To set up a timer in React. We used the time-elapsed information to provide users with V60 recipe instructions in intervals.
  • To use React Bootstrap components such as DropdownButton and Modal to provide users with an interactive experience.
  • To write CSS that allows the app to be responsive to both PC and mobile.

📜 Running on Local

To run the ☕️ Brew Mate locally, follow these steps:

  1. Install dependencies: npm install
  2. Start the development server: npm start

Make sure you have Node.js and npm installed on your machine before proceeding with the installation.

💻 Technologies Used

☕️ Brew Mate was built using the following technologies:

  • React: A JavaScript library for building user interfaces.
  • React Bootstrap: Bootstrap JavaScript front-end framework built for React which provides compatible UI components
  • react-countdown-circle-timer: Library that provides a React countdown timer component in a circle shape with color and progress animation.

🌈 Features

  • Choose recipe: Users can choose a from a list of V60 recipes from the dropdown list in the landing page.

  • FAQ and Preparation Infomation: Users can view the FAQ and Preparation Infomation from the modal displayed by clicking the ? and Preparation button.

  • Time based step by step V60 brewing instructions display: Users can follow the step-by-step V60 brewing instructions displayed depending on the time interval that the brewing process is at.

  • Timer: Users can view the time-elapsed information to determine whether the brew was longer or shorten than expected. Users can also view the countdown timer animation to guide the speed of pouring.

🔮 Future Enhancements

Here are some possible enhancements and additional features to be implemented in the future:

  • Previous and Skip button: To allow users to preview instructions without waiting for the timer.
  • Brew Journal: To allow users to add their notes on their brew with the selected recipe.
  • Save custom recipe: To allow users to add their brewing recipe.

💽 Data Source

The V60 Recipes used in this app were sourced from the Pouroverproject.com and James Hoffman's YT Channel.

About

A WebApp that allow users to make good coffee consistently by following V60 coffee brewing recipes step by step with a timer

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published