Skip to content

the-collab-lab/tcl-61-smart-shopping-list

Repository files navigation

Overview

Introducing PREDICT-A-BUY: The Ultimate Shopping Companion!

With PREDICT-A-BUY by your side, shopping becomes an adventure, a journey through time. Let the app be your trusty sidekick, anticipating your needs and guiding you through the aisles with its charming personality. Say goodbye to mundane shopping lists and hello to a shopping experience that's as fun and sassy!

How does it work?

As a user, you will enter items (e.g., “Greek yogurt” or “Paper towels”) into your list. Each time you buy the item, you mark it as purchased in the list. Over time, the app comes to understand the intervals at which you buy different items. If an item is likely to be due to be bought soon, it rises to the top of the shopping list.

Installing

1. Clone the product locally

  • On GitHub, navigate to the repo for your cohort’s project (you’re probably there right now), then:
  • Click on the "Code" tab. It may already be selected.
  • Click the green "Code" button to reveal a "Clone" popup.
  • The "HTTPS" tab should be automatically selected. If not, click "HTTPS."
  • Click the copy button to copy the url of this repository to your clipboard. screenshot of "Code" tab on GitHub
  • From your terminal, cd into the directory where you want this project to live. screenshot of how to navigate folders in terminal
  • Once you’re in the directory, type git clone followed by the web URL you just copied to your clipboard from GitHub. Then cd into the directory that is created.

2. Install dependencies

  • Once you’ve cloned the project locally and you’re in the project directory, you’ll want to install the project’s dependencies. To do so, type the following into your terminal: npm install

3. Access the product in your browser

After you’ve cloned the project locally and updated the dependencies, run the project by typing the following into your terminal: npm start. You should be able to see the project at localhost:3000.

Technologies:

This project was built utilizing a combination of React, HTML, SASS, JavaScript and Firebase.

Features

  • Users can look at what's on the list, so they know what they need to buy.
  • Users can navigate among the pages of our application, Home, List and Add Item.
  • A shopping list is a set of items associated with a specific three-word token. We allow users to start new lists, so you can save the things you need to buy or share your shopping list with your friends by entering the existing token.
  • Users can add or delete items to your shopping lists.
  • Users can search through your list.
  • Users can mark your items as purchased, so you can track what on your list you do and do not need to buy.
  • Overtime, the app advises users about when to purchase things.
  • The app sorts items by how soon you might need to buy them (soon, kind of soon, not soon,and inactive).

Notes:

  • Need to buy soon (7 days or fewer until the next purchase)
  • Need to buy kind of soon (between 7 & 30 days until the next purchase)
  • Need to buy not soon (30 days or more until the next purchase)
  • Inactive (60 days have passed since the last purchase)

Demo

ezgif.com-gif-maker.1.mov

Future contributions and requests:

PRs are welcome!

Credits:

Mentors:

License

MIT

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published