Skip to content

ijayhub/pantry-tracker-app

Repository files navigation

Pantry Tracker Website

Table of Contents

Table of Contents
  1. About The Project
  2. Built With
  3. Getting Started
  4. Docker Setup
  5. Deployment to AWS App Runner
  6. Conclusion
  7. Future Improvements

About The Project

Pantrify: Simplify Your Pantry Management App | Add, Edit, Delete, and Search Items

Your ultimate pantry management solution.

Key Features

  • Page Navigation: The ability to navigate between pages seamlessly.
  • Add new pantry items easily.
  • Delete items you no longer need.
  • Edit existing items for accurate tracking.
  • Search for items quickly to find what you need.

Overview

(back to top)

Built With

(back to top)

Getting Started

To get a local copy up and running, follow these simple steps:

Available Scripts

In the project directory, you can run:

npm run dev

Runs the app in the development mode.

Open http://localhost:3000 to view it in your browser.

The page will reload when you make changes.

You may also see any lint errors in the console.

(back to top)

Contanization of the application

Technologies Used

  • Frontend: Next.js, React, Tailwind CSS.

  • Backend: Firebase (Firestore for database).

  • Deployment: AWS App Runner, AWS Elastic Container Registry (ECR), Docker.

(back to top)

Installation

Prerequisites

Ensure you have the following installed on your system:

(back to top)

Clone the Repository

git clone https://github.com/ijayhub/pantry-tracker-app.git cd pantry-tracker-app 

Install Dependencies

npm install 

(back to top)

Run the Application Locally

npm start 

The app will be available at http://localhost:3000/.

(back to top)

Docker Setup

To containerize the application for deployment:

Create a Dockerfile

FROM node:18-alpine WORKDIR /app COPY package.json package-lock.json ./ RUN npm install COPY . . EXPOSE 3000 CMD ["npm", "run", "start"] 

(back to top)

Build and Run the Docker Container

docker build -t pantry-tracker-app . docker run -p 3000:3000 pantry-tracker-app 

(back to top)

Deployment to AWS App Runner

Push Docker Image to AWS Elastic Container Registry (ECR)

aws ecr create-repository --repository-name pantry-tracker-app aws ecr get-login-password --region <your-region> | docker login --username AWS --password-stdin <aws-account-id>.dkr.ecr.<your-region>.amazonaws.com docker tag pantry-tracker-app:latest <aws-account-id>.dkr.ecr.<your-region>.amazonaws.com/pantry-tracker-app:latest docker push <aws-account-id>.dkr.ecr.<your-region>.amazonaws.com/pantry-tracker-app:latest 

(back to top)

Deploy to AWS App Runner

  • Go to the AWS App Runner Console.

  • Create a new service and select Container Registry.

  • Choose your ECR repository and select the latest image.

  • Configure environment variables and deployment settings.

  • Deploy the service.

(back to top)

Conclusion

Pantry Tracker App provides an efficient way to manage pantry inventory.

(back to top)

Future improvements

  • User authentication
  • Notifications
  • Enhanced UI features.

(back to top)

For contributions and issues, visit the GitHub Repository.

(back to top)

About

Your ultimate pantry management solution.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published