Skip to content

Latest commit

 

History

History
74 lines (59 loc) · 2.82 KB

README.md

File metadata and controls

74 lines (59 loc) · 2.82 KB

Pantry Tracker

Overview

Pantry Tracker is a pantry management application that allows users to keep track of pantry items by adding or removing items and updating their quantities. The project is built using Next.js as the frontend framework, Material UI for the UI components, and Firebase as the backend service.

Features

  • Add new pantry items
  • Remove existing pantry items
  • Update the quantities of pantry items
  • User authentication with Firebase
  • Responsive design using Material UI

Technologies Used

  • Next.js - A React framework for building server-side rendered applications.
  • React - A JavaScript library for building user interfaces.
  • Material UI - A popular React UI framework for building responsive and accessible components.
  • Firebase - A platform developed by Google for creating mobile and web applications, used here for backend services such as authentication and database.

Installation

To get started with the Pantry Tracker project, follow these steps:

  1. Clone the repository

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

  2. Install dependencies

    npm install

  3. Set up Firebase

    • Create a Firebase project at Firebase Console.
    • Enable Firestore and Authentication services.
    • Obtain your Firebase configuration and create a .env.local file in the root of your project with the following environment variables: 
      NEXT_PUBLIC_FIREBASE_API_KEY=your-api-key
NEXT_PUBLIC_FIREBASE_AUTH_DOMAIN=your-auth-domain
NEXT_PUBLIC_FIREBASE_PROJECT_ID=your-project-id
NEXT_PUBLIC_FIREBASE_STORAGE_BUCKET=your-storage-bucket
NEXT_PUBLIC_FIREBASE_MESSAGING_SENDER_ID=your-messaging-sender-id
NEXT_PUBLIC_FIREBASE_APP_ID=your-app-id

  4. Run the development server

    npm run dev

  5. Open the application

Usage

  1. Sign Up / Sign In

    • Create a new account or sign in with your existing account using the Firebase Authentication service.

  2. Manage Pantry Items

    • Add new items to your pantry by providing the item name and quantity.
    • Update the quantity of existing items.
    • Remove items that you no longer need.

Contributing

Contributions are welcome! If you have any ideas, suggestions, or bug reports, feel free to create an issue or submit a pull request.

License

This project is licensed under the MIT License. See the LICENSE file for details.

Acknowledgements