Pantry

Live Demo of Pantry

Topics

• Overview
• Video Walkthrough
• MVP Features for Pantry
• ERD & Wireframe
• Clone/Install the Project Instructions
• Learn More about Next.js
• Contributors
• Tech and Frameworks Used
• API Reference

---

Pantry Overview

• The ideal user for Pantry is someone who likes to cook meals, especially those strapped for time or resources.
• Users can keep track of the ingredients they have in their pantry by entering them into Pantry, and always have a real time view of what they have, and how much.
• Users can find recipes that match the ingredients they currently have, and dynamically update the amount of an ingredient they have in their pantry based on the recipes they make.

---

Video Walkthrough of Pantry

• link

---

MVP Features for Pantry

• User signs in with Google Auth
• Users can see public recipes that other users have created, as well as private recipes that they have created
• Users can add ingredients to their pantry via an external API
• Users can see on a recipe page whether they have an ingredient/enough of an ingredient to make a recipe

---

ERD & Wireframe

---

Clone/Install the Project Instructions

1. Create a Firebase project and set up authentication.
2. Create a .env file at the root of the project
3. Copy/Paste the contents of the .env.sample file to your newly created .env file.
4. Copy over all of your Firebase values into the .env file.
5. Create/Import sample data to project directory and Realtime Database
6. Open the package.json file and change the name property to the name of your application, and author to your name.
7. From your command line, be in the root directory and run npm install OR npm i for short.
8. Next, run npm run prepare. This command sets up husky to track eslint errors on commit that will make your deploy fail on Netlify.
9. To start your application, run npm run dev.
10. Open http://localhost:3000 with your browser.
11. Deploy on Netlify: Netlify will automatically detect your project and prepopulate the settings, but should something go wrong and it does not, here are the commands:

• Build Command: npm run build
• Publish directory: .next

1. Any Enviromental variables you are using in your .env file should be added to Netlify. Go to Site settings > Build & deploy > Environment > Environment variables and the keys and values there.
2. In Firebase under Authentication select sign in methods, scroll to Authorized domains. Add your Netlify URL.

Learn More about Next.js

To learn more about Next.js, take a look at the following resources:

• Next.js Documentation - learn about Next.js features and API.
• Learn Next.js - an interactive Next.js tutorial.

Contributors

• Wesley Vance

Tech and Frameworks Used

API Reference