"Early Prototype: This is a glimpse into the future! Although it's currently a basic Dockerized Spring server with MongoDB accessible at localhost, we're actively developing powerful features. Keep an eye out for the upcoming beta version!" 👨🏽💻🌱
Pantry Planner is a web application that helps you manage your food stores, develop cooking recipes, create meal plans, and generate shopping lists. With Pantry Planner, you can keep track of your ingredients and recipes in one place, so you always know what you have and what you need to buy.
- Add, edit, and delte ingredients and recipes
- create and edit meal plans for the week
- Generate shopping lists based on meal plans
- Search for recipes by name or ingredient
- View recipe details, including ingredients, directions, and nutritional information
- Mark ingredients as "in stock" or "out of stock"
- View a dashboard with a summary of your food stores and upcoming meals
- Eclipse-Temurin Java 17 SDK
- Spring Boot
- MongoDB
- Gradle
- Docker
To use Pantry Planner, you can either run the application locally on your computer or access it online if its deployed to a server.
- Install Docker and Docker Compose if you haven't already.
- clone the git repo into a directory on your local machine.
- In a linux terminal navigate to the root directory of the project and run the provide shell script gradle-docker.sh
- Following the build process now we can run
docker-compose upto start the application and the database. - Open a web browser and navigate to
http://localhost:8080
If the application is deployed to a server, you can access it using a web browser. Contact the administrator of the server for the URL and login credentials.
We welcome contributions to Pantry Planner! If you encounter a bug or have a feature request, please open an issue on the project's issue tracker at GitHub. When submitting an issue, please provide as much detail as possible, including steps to reproduce the problem.
If you'd like to contribute code, please follow these steps:
- Fork the repository.
- Create a new branch for your feature or bug fix.
- Make your changes and test them thoroughly.
- Commit your changes and push them to your fork.
- Open a pull request to the main repository.
We'll review your changes and work with you to merge them into the main branch
Thank you for your interest in contributing to Pantry Planner!
Pantry Planner is licensed under the MIT License. See LICENSE for details.
Pantry Planner was developed by Dennis Vargas as a personal project to resolve the head ache of meal planning and food storage management.