Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/shivah12/pantry_manager

A simple CRUD application called Pantry Manager created using tech stack NextJs, MUI and leveraged Firestore Database for the record keeping
https://github.com/shivah12/pantry_manager

firebase-realtime-database headstarter-ai material-ui nextjs

Last synced: 12 days ago
JSON representation

A simple CRUD application called Pantry Manager created using tech stack NextJs, MUI and leveraged Firestore Database for the record keeping

Awesome Lists containing this project

README

        

Pantry Manager


Pantry Manager is a simple CRUD (Create, Read, Update, Delete) application designed to help you manage your pantry items efficiently. This application is built using modern web technologies, ensuring a smooth and responsive user experience.

Tech Stack

Frontend: Next.js, JavaScript, MUI (Material-UI)
Backend: Firestore Database

Features

Create: Easily add new pantry items with details like name, quantity, and expiration date.
Read: View all your pantry items in a clean and organized layout.
Update: Modify the details of your pantry items as needed.
Delete: Remove items that are no longer needed or have expired.

Getting Started


Prerequisites

Node.js (>=12.x)
npm or yarn
Firebase account (for Firestore Database)

Installation

Clone the repository:

git clone https://github.com/yourusername/pantry-manager.git
cd pantry-manager

Install dependencies:

npm install

Set up Firebase:

Create a Firebase project and enable Firestore.
Download the Firebase config file (firebaseConfig.js) and place it in the root of your project.
Ensure the Firestore rules are properly set up to allow CRUD operations.

Run the development server:

bash
npm run dev

Open http://localhost:3000 to view the application in the browser.

Deployment

Pantry Manager can be easily deployed to platforms like Vercel, Firebase Hosting, or any other static hosting service that supports Next.js.

npm run build
npm run start

Contributing

Contributions are welcome! If you have any ideas, suggestions, or bug reports, please open an issue or submit a pull request.

License

This project is licensed under the MIT License.