https://github.com/giovaneiwamoto/meal-planner
🍇 Meal Planner - Designed to simplify and personalize meal planning, providing a customized meal plan based on dietary preferences and nutritional goals. Powered by Spoonacular API.
https://github.com/giovaneiwamoto/meal-planner
api aws docker ec2 ecr
Last synced: 8 months ago
JSON representation
🍇 Meal Planner - Designed to simplify and personalize meal planning, providing a customized meal plan based on dietary preferences and nutritional goals. Powered by Spoonacular API.
- Host: GitHub
- URL: https://github.com/giovaneiwamoto/meal-planner
- Owner: GiovaneIwamoto
- License: mit
- Created: 2024-04-23T16:26:13.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-02-09T22:11:58.000Z (9 months ago)
- Last Synced: 2025-02-09T23:20:36.310Z (9 months ago)
- Topics: api, aws, docker, ec2, ecr
- Language: JavaScript
- Homepage:
- Size: 339 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# MEAL PLANNER
### **OVERVIEW**
This project aims to develop the Meal Planner an application designed to simplify and personalize meal planning, providing a customized meal plan based on dietary preferences and nutritional goals, enabling an easier path to eating tailored to your objectives. The application has been designed for cloud deployment, utilizing Docker for containerization, AWS EC2 to provide scalable and on-demand computational power, and Amazon ECR for storing and managing Docker images. This ensures optimized, scalable, and reliable performance in the cloud.
[](https://skillicons.dev)
---
https://github.com/user-attachments/assets/368e3e3c-d728-4b5c-aa65-d11a836b1a8d
---
### **MAIN FEATURES**
- **Customization**: The application allows for the adjustment of meal plans, which can be weekly or daily, adopting any specific diet such as Omnivore, Pescetarian, Vegetarian, Ovo-Vegetarian, Lacto-Vegetarian, or Vegan, in addition to the possibility of limiting the number of daily calories.
- **Convenience**: Specific information can be checked, such as the price of ingredients in the recipe or how sweet, salty, and spicy it is, for example.
- **Practicality**: Details about the recipe are easily accessible, such as required ingredients, preparation time, number of servings, and a brief summary of the recipe.
- **Cloud Integration**: The combination used offers an efficient application through on-demand computing from AWS EC2, a secure repository for Docker image manipulation with AWS ECR, and encapsulation in containers provided by Docker, ensuring more agility and ease in the execution and testing of the system.
> [!WARNING]
> It is imperative for users to deploy their own application on AWS using their own credentials to ensure compliance and security. This ensures that users have full control over their application's environment and data, facilitating customization and enhancing security measures.
---
### **ARCHITECTURE**
### **BACKEND ENDPOINTS**
| **HTTP VERB** | **ENDPOINT** | **ACTION** |
| ------------- | ------------------------------ | ------------------------ |
| GET | `/meal-plan/` | Generate meal plan |
| GET | `/price-breakdown/{recipe_id}` | Get price of ingredients |
| GET | `/recipe-details/{recipe_id}` | Get recipe details |
| GET | `/taste/{recipe_id}` | Get flavor information |
---
### **INSTALLATION GUIDE**
> RUN DOCKER COMPOSE
```ruby
$ docker compose -f docker-production.yml up
```
> [!CAUTION]
> Credentials should remain local to your environment only. Never expose your credentials in any part of the code, such as in source files, comments, or commit history. Instead, use environment variables or secure secret management tools to manage and access your credentials securely.
---
### **AUTHORS**
[Giovane Iwamoto](https://github.com/GiovaneIwamoto) | [Felipe Pelissari](https://github.com/FeliPellissari) | [Isabela Buzzo Galvão](https://github.com/isabelabuzzo) | [Leandro Pereira](https://github.com/leojgpereira)
Giovane Hashinokuti Iwamoto - Computer Science student at UFMS - Brazil - MS
I am always open to receiving constructive criticism and suggestions for improvement in my developed code. I believe that feedback is an essential part of the learning and growth process, and I am eager to learn from others and make my code the best it can be. Whether it's a minor tweak or a major overhaul, I am willing to consider all suggestions and implement the changes that will benefit my code and its users.