https://github.com/mungasoftwiz/smart-pantry

A pantry management application designed to help users keep track of pantry items efficiently.
https://github.com/mungasoftwiz/smart-pantry

ci-cd firebase fullstack-development image-classification material-ui nextjs search vercel-deployment

Last synced: 8 days ago
JSON representation

A pantry management application designed to help users keep track of pantry items efficiently.

• Host: GitHub
• URL: https://github.com/mungasoftwiz/smart-pantry
• Owner: MungaSoftwiz
• Created: 2024-07-30T15:16:14.000Z (5 months ago)
• Default Branch: main
• Last Pushed: 2024-08-05T23:33:02.000Z (5 months ago)
• Last Synced: 2024-11-07T08:46:31.768Z (about 2 months ago)
• Topics: ci-cd, firebase, fullstack-development, image-classification, material-ui, nextjs, search, vercel-deployment
• Language: JavaScript
• Homepage: https://smart-pantry-nine.vercel.app
• Size: 163 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 7
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Smart Pantry

Smart Pantry is a pantry management application designed to help users keep track of pantry items efficiently. With this app, users can add, update, and delete pantry items, search for specific items, and even receive recipe suggestions based on their current inventory. Built with Next.js, Material UI, and Firebase, Smart Pantry offers a seamless and intuitive user experience.

## Features

- **Add, Update, and Delete Items**: Easily manage pantry items through a user-friendly form.

- **Search and Filter**: Quickly find specific items using search and filter functionality.

- **Image Capture**: Take pictures of items using mobile or browser cameras.

- **Image Classification**: Classify images using GPT Vision API or other LLMs.

- **Recipe Suggestions**: Get recipe suggestions based on your pantry contents using the OpenAI API or OpenRouter API.

## Technologies Used

- **Frontend**: Next.js, Material UI

- **Backend**: Firebase

- **Deployment**: Vercel

- **Image Classification**: GPT Vision API, GCP Vertex AI or AutoML (Bonus Feature)

- **Recipe Suggestions**: OpenAI API or OpenRouter API (Bonus Feature)

- **CI/CD**: GitHub Actions

## Installation

To get started with smart-pantry, follow these steps:

1. **Clone the Repository**

   ```bash

   git clone https://github.com/your-username/smart-pantry.git

   ```

2. **Navigate to the Project Directory**

   ```bash

   cd smart-pantry

   ```

3. **Install Dependencies**

   ```bash

   npm install

   ```

## Set Up Firebase

   - Create a Firebase project and configure Firestore.

   - Add your Firebase configuration to the project.

## Run the Development Server

   ```bash

   npm run dev

   ```