Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/prashantzzz/mealplannerapi
Backend of Guvi-Chubb Capstone Project
https://github.com/prashantzzz/mealplannerapi
csharp dotnet sql-server
Last synced: about 2 months ago
JSON representation
Backend of Guvi-Chubb Capstone Project
- Host: GitHub
- URL: https://github.com/prashantzzz/mealplannerapi
- Owner: prashantzzz
- License: mit
- Created: 2024-12-01T10:09:31.000Z (2 months ago)
- Default Branch: master
- Last Pushed: 2024-12-09T14:08:08.000Z (about 2 months ago)
- Last Synced: 2024-12-09T15:22:16.276Z (about 2 months ago)
- Topics: csharp, dotnet, sql-server
- Language: C#
- Homepage:
- Size: 331 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# **Recipe and Meal Planning Management System**
## **Check Swagger UI pdf**
- Stores the pdf of all the endpoints
## **Project Overview**
- User Authentication: Secure login with role-based access (Admin, Chef, Nutritionist, Customer, Meal Planner).
- Recipe Management: Create and manage recipes with ingredients, cooking details, and nutritional info.
- Meal Planning: Personalized meal plans based on dietary needs and preferences.
- Shopping Lists: Auto-generated lists with ingredient tracking and stock management.
- Nutritional Tracking: Track daily intake against goals with detailed recipe nutrition data.
- Dietary Preferences: Custom meal suggestions based on dietary restrictions.
- Cooking Instructions: Step-by-step recipes with ratings and reviews.
- Subscription & Payments: Manage subscriptions for meal plans and services.
- Analytics: Reports on nutrition, meal adherence, and recipe popularity.
- Meal Prep & Portion Control: Adjust portions and get meal prep tips.
- Multi-Platform: Accessible on desktop, tablet, and mobile.
---
## **Tech Stack**
- **Backend:** .NET 8 (C#)
- **Frontend:** Angular 17+
- **Database:** SQL Server 2022
- **Authentication:** JWT
---
## **Features**
1. **User Authentication & RBAC**
- Secure login for Admin, Chef, Nutritionist, Customer, and Meal Planner.
- Role-specific permissions.
- Only admin can register admins
2. **Recipe Management**
- Create, update, and manage recipes with categories and dietary preferences.
3. **Meal Planning**
- Personalized meal plans with scheduling and nutritional tracking.
4. **Shopping List Management**
- Generate and manage shopping lists based on meal plans.
5. **Analytics & Reporting**
- Insights on recipe popularity, meal adherence, and grocery spending.
---
## **Setup Instructions**
1. **Clone the Repository**
```bash
git clone
cd MEALPLANNERAPI
```
2. **Database Configuration**
Update the connection string in `appsettings.json`:
```json
"ConnectionStrings": {
"DefaultConnection": "Your_Connection_String_Here"
}
```
3. **Install Dependencies**
```bash
dotnet restore
```
4. **Run Migrations**
```bash
dotnet ef database update
```
5. **Run the Application**
```bash
dotnet run
```
---
## **Few API Endpoints**
### **Authentication**
| Endpoint | Method | Description |
|------------------------|--------|-------------------------------------|
| `/api/auth/login` | POST | User login with JWT generation |
| `/api/auth/register` | POST | Register a new user (Admin-only) |
| `/api/auth/logout` | POST | User logout |
---
### **User Management**
| Endpoint | Method | Description |
|------------------------|--------|-------------------------------------|
| `/api/users` | GET | Get all users (Admin-only) |
| `/api/users/{id}` | GET | Get user details by ID |
| `/api/users/{id}` | PUT | Update user details (Admin-only) |
| `/api/users/{id}` | DELETE | Delete user (Admin-only) |
---
### **Recipes**
| Endpoint | Method | Description |
|------------------------|--------|-------------------------------------|
| `/api/recipes` | GET | Get all recipes |
| `/api/recipes/{id}` | GET | Get a recipe by ID |
| `/api/recipes` | POST | Create a new recipe (Chef/Nutritionist) |
| `/api/recipes/{id}` | PUT | Update a recipe (Chef/Nutritionist) |
| `/api/recipes/{id}` | DELETE | Delete a recipe (Chef/Nutritionist) |
---
### **Meal Planning**
| Endpoint | Method | Description |
|-------------------------|--------|-------------------------------------------|
| `/api/mealplans` | GET | Get all meal plans for the logged-in user |
| `/api/mealplans/{id}` | GET | Get a specific meal plan by ID |
| `/api/mealplans` | POST | Create a new meal plan |
| `/api/mealplans/{id}` | PUT | Update an existing meal plan |
| `/api/mealplans/{id}` | DELETE | Delete a meal plan |
---
### **Shopping List**
| Endpoint | Method | Description |
|-----------------------------|--------|-------------------------------------|
| `/api/shoppinglists` | GET | Get all shopping lists |
| `/api/shoppinglists/{id}` | GET | Get a shopping list by ID |
| `/api/shoppinglists` | POST | Add a shopping list for a meal plan |
| `/api/shoppinglists/{id}` | PUT | Update shopping list item status |
| `/api/shoppinglists/{id}` | DELETE | Delete a shopping list |
---
---
### **Assigned Users List**
| Endpoint | Method | Description |
|--------------------------------|--------|-------------------------------------|
| `/api/assignedusers` | GET | Retrieve all assigned users. |
| `/api/assignedusers/{id}` | GET | Retrieve a specific record by ID. |
| `/api/assignedusers` | POST | Add a new assigned user. |
| `/api/assignedusers/{id}` | PUT | Update an assigned user by ID. |
| `/api/assignedusers/{id}` | DELETE | Delete an assigned user data. |
---
---
### **MealPrep List**
| Endpoint | Method | Description |
|--------------------------|--------|-------------------------------------|
| `/api/mealprep` | GET | Retrieve all meal preparations. |
| `/api/mealprep/{id}` | GET | Retrieve a specific meal preparation|
| `/api/mealprep` | POST | Addd a new meal preparation. |
| `/api/mealprep/{id}` | PUT | Update a meal preparation by ID. |
| `/api/mealprep/{id}` | DELETE | Delete a meal preparation by ID. |
---
### **Reviews**
| Endpoint | Method | Description |
|------------------------|--------|-------------------------------------|
| `/api/reviews` | GET | Get all reviews for a recipe |
| `/api/reviews` | POST | Add a new review for a recipe |
| `/api/reviews/{id}` | GET | Get review by Id |
| `/api/reviews/{id}` | PUT | Update a review |
| `/api/reviews/{id}` | DELETE | Delete a review |
---
### **Subscriptions**
| Endpoint | Method | Description |
|----------------------------|--------|-------------------------------------|
| `/api/subscriptions` | GET | Get all subscriptions for a user |
| `/api/subscriptions/{id}` | POST | Create a new subscription |
| `/api/subscriptions/{id}` | PUT | Update subscription details |
| `/api/subscriptions/{id}` | DELETE | Cancel a subscription |
---
## **Frontend Integration**
- Connect Angular frontend to the backend using the base URL:
`https://localhost:/api/`
---
## **Additional Notes**
- Use Swagger (`/swagger`) for testing APIs.
- Add CORS policies in `Program.cs` for external integrations.
---