Skip to content

Latest commit

 

History

History
37 lines (30 loc) · 1.7 KB

README.md

File metadata and controls

37 lines (30 loc) · 1.7 KB
Raw

MealPlanner

MealPlanner is a web app made to help you plan meals, which helps save time and money.

Try it here
(Log in with username: example, password: password)
(Sign up disabled, set up locally using instructions below to try sign up)

Set Up

To set up this project and run it for yourself follow the steps below:

  1. Clone this repo to a folder on your device.
  2. Create a file in the repository named 'localdb'
  3. Run the program using the following commands:
    1. npm run-script setup
    2. mongod --dbpath localdb (in a separate terminal)
    3. npm run-script build-run
  4. The site should now be available locally on localhost:5000

Usage

Starting from the home page (localhost:5000), click on the "Get Started" button which will take you to the sign in page if not logged in.
Once there create an account and you will be redirected to the calendar view of the project, where most of the functionality is. Once here the following actions are available to you:

  1. Select any date on the calendar to view meals set for that date.
    1. Click on the new meal button to create a new meal for that day
  2. Click on Generate Shopping List to generate your shopping list of needed ingredients based on the ingredients needed for your meals, and the ingredients you already have.
    1. Export the list by copying it, printing it, or emailing it
  3. Click on Ingredients List to set the ingredients you already have. These will be removed from the shopping list

Technologies Used

  • Node.js - backend/running server
  • Expressjs - MealPlanner api
  • Mongoose - Schemas for MongoDB
  • MongoDB - Database for users, meals, ingredients
  • React
  • Material-UI
  • HTML/CSS/JavaScript