README.md

Inventory Management With Gemini

This project aims to simplify the manual process of adding items to inventory and managing them by including the ability to simply take a picture and instantly add the item to Inventory without having to manually type the name.
Read the Case Study here

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Roadmap
4. License

About The Project

I built this project while doing my fellowship at Headstarter. It was the first project I built to learn how to use Generative AI in apps to improve ease of use.

(back to top)

Built With

• 
• 
• 
• 
• 

(back to top)

Getting Started

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

Prerequisites

• npm

  npm install npm@latest -g

Installation

1. Get a free API Key at https://aistudio.google.com/app/apikey
2. Clone the repo

   git clone https://github.com/faisalbhuiyan3038/inventory-management.git

3. Install NPM packages

   npm install

4. Store your API key in .env

   const GEMINI_API_KEY = YOUR_API_KEY

5. Change git remote url to avoid accidental pushes to base project

   git remote set-url origin faisalbhuiyan3038/inventory-management
   git remote -v # confirm the changes

6. Run the project in development mode.

   npm run dev

(back to top)

Roadmap

• Fetch inventory from firebase
• Add new items to db
• Increase/Decrease quantity of items to db
  • Handle deleting item if quantity 0.
• Implement minimal design
• Implement responsive camera component
• Manage camera devices and image
• Connect Gemini and analyze image

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

(back to top)

License

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

(back to top)