Grocery-Price-Tracker

An app to help you save money on groceries!
Explore the docs »

Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Acknowledgments

About The Project

I've always been a frugal shopper, always looking for deals and waiting for sales to stock up on my frequently purchased items. With groceries making up the bulk of my purchases throughout the year by a wide margin, it seemed like the right place to focus my efforts to save the most money. I kept finding myself missing out on sales either by catching them too late, or seeing them right after I made a purchase, so I decided to make an app that would allow me to track my frequently purchased items and never miss another sale.

(back to top)

Built With

(back to top)

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

• npm

  npm install npm@latest -g

Installation

1. Set up a database with MongoDB
2. Clone the repo

   git clone https://github.com/ianstewart4/grocery-price-tracker.git

3. Install NPM packages

   npm install

4. Create a .env file in the main directory using the following variables

   NODE_ENV = development
   PORT = 8000
   API_KEY -> You can get this from the Superstore website
   DB_STRING 
   
   DB_USERNAME
   DB_PASSWORD 
   
   JWT_SECRET

5. Run development server

   npm run dev

(back to top)

Usage

Coming soon...

(back to top)

Roadmap

• Let users look up items using item code
• Change theme selector to light/dark toggle with default being system setting
• Allow users to select their store
• Allow users to create a list of watched and tracked items
• Allow users to set up and receive email notification of items on sale
• Allow users to search for items directly in the app
• Track price history
• Add other chains
  • Other Loblaws chains
  • Walmart
  • Sobeys

See the open issues for a full list of proposed features (and known issues).

Ideas

• Allow users to generate and edit printable grocery lists
• Let users add items to a basket which will let users quickly check which stores have the best prices
• Show user which store/location has the best price for each item within a user's chosen radius
• If a user is willing to make trips to multiple stores, create printable lists for items with the best price and respective locations
  • Let users select number of stops they're willing to make

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Acknowledgments

• Othneil Drew's Best-README-Template
• Choose an Open Source License
• Malven's Flexbox Cheatsheet
• Malven's Grid Cheatsheet
• Img Shields
• Font Awesome
• React Icons

(back to top)