https://github.com/suraj-kumar00/pantry-pro

Making a Pantry Application
https://github.com/suraj-kumar00/pantry-pro

headstarter-ai pantry-inventory

Last synced: 16 days ago
JSON representation

Making a Pantry Application

• Host: GitHub
• URL: https://github.com/suraj-kumar00/pantry-pro
• Owner: Suraj-kumar00
• License: mit
• Created: 2024-07-30T12:03:14.000Z (5 months ago)
• Default Branch: main
• Last Pushed: 2024-08-15T13:03:04.000Z (5 months ago)
• Last Synced: 2024-08-15T14:57:22.242Z (5 months ago)
• Topics: headstarter-ai, pantry-inventory
• Language: JavaScript
• Homepage: https://pantry-pro.vercel.app/
• Size: 226 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
![pantry-pro](https://socialify.git.ci/Suraj-kumar00/pantry-pro/image?description=1&descriptionEditable=PantryPro%3A%20Keeping%20Your%20Kitchen%20Stocked%20and%20Sorted.%0A&font=Raleway&forks=1&issues=1&language=1&name=1&owner=1&pattern=Floating%20Cogs&pulls=1&stargazers=1&theme=Dark)

## Demo Video of the Project:

[![Watch the video](https://img.youtube.com/vi/9SuAyzMrPGI/0.jpg)](https://www.youtube.com/watch?v=9SuAyzMrPGI)

## Tech Stack Needed for this Project:

### Frontend:

- Next.js

- React

- Material UI

### Backend:

- Firebase

- GCP

- OpenAI

### Hosting and Deployment:

- Vercel

### DevOps:

- CI/CD

- Docker

## Run the Project with Docker:

#### You must have to install Docker Desktop for this step:

1. First of all pull the image into your local machine:

```docker

docker pull surajkumar00/pantry-pro

```

2. Run the `Dcoker Container` using `pulled Docker Image` :

```docker

docker run -it -p 3000:3000 surajkumar00/pantry-pro

```

## Features of Pantry Pro:

- [x] A form to add, delete, and update pantry items

- [x] A search or filter functionality to easily find items

- [x] A presentable frontend design to display all pantry items

- [x] Deployed to Vercel and use CI/CD 

- [x] Can add inventry items via uploading an images

## Set Up Guide:

```bash

npx create-next-app@latest

```

```bash

npm install @mui/material @emotion/react @emotion/styled

```

### Implement a Firebase Backend for data Storage

##### First install `firebase`

```bash

npm install firebase

```

**Go to the firebase official website and create new project**

##### Copy pase this code in `firebase.js` which should be in you project's root directory

```bash

// Import the functions you need from the SDKs you need

import { initializeApp } from "firebase/app";

import { getAnalytics } from "firebase/analytics";

// TODO: Add SDKs for Firebase products that you want to use

// https://firebase.google.com/docs/web/setup#available-libraries

// Your web apps Firebase configuration

// For Firebase JS SDK v7.20.0 and later, measurementId is optional

const firebaseConfig = {

  apiKey: "",

  authDomain: "",

  projectId: "",

  storageBucket: "",

  messagingSenderId: "",

  appId: "",

  measurementId: ""

};

// Initialize Firebase

const app = initializeApp(firebaseConfig);

const analytics = getAnalytics(app);

```

#### And now you are ready to work with project

---

## License 📝

This repo is licensed under the terms of the MIT License. check out [LICENSE](https://github.com/Suraj-kumar00/pantry-pro/blob/main/LICENSE) for details.

---

## Support 🌱

_We would love to have you, feel free to open issues and pull requests, and Don't forget to leave a star ⭐_