Skip to content

finish the readme part, the usersotry description #156

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
changlong050-lgtm wants to merge 1 commit into
base: main
Choose a base branch
from
Open

finish the readme part, the usersotry description #156

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 16 additions & 15 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,47 +1,48 @@
# [your app name here]
# LazyEat

CodePath WEB103 Final Project

Designed and developed by: [your names here]
Designed and developed by: Fabian, Liam, Raheem, Steph



🔗 Link to deployed app:

## About

### Description and Purpose

[text goes here]
LazyEats is a full-stack web app that helps busy, budget-conscious people eat healthier without spending hours in the kitchen. Users can browse quick recipes (under 30 minutes), track their daily nutrition intake, and see how their meals compare to recommended daily values for key nutrients like protein, iron, and vitamin C. Every recipe includes an estimated cost and cooking time so users can plan meals around their weekly food budget.

### Inspiration

[text goes here]
A lot of people — including myself — struggle to eat well, not because they don't care, but because healthy eating feels complicated and expensive. I often skip meals or reach for chips because I'm too lazy to cook, and I know I'm not alone. Poor nutrition affects how you feel and perform every day, yet most food apps are either too complex or ignore budget constraints entirely. LazyEats was built for people who want to eat better but need simple, affordable, and fast options to make that actually happen.


## Tech Stack

Frontend:
Frontend: React, React Router, CSS

Backend:
Backend: Node.js, Express, PostgreSQL

## Features

### [Name of Feature 1]

[short description goes here]
### Recipe Browser

Browse and search all recipes filtered by cook time, budget, and nutritional goals. Users can add, edit, and delete recipes with full form validation.
[gif goes here]

### [Name of Feature 2]

[short description goes here]
### Daily Nutrition Tracker

Log meals throughout the day and automatically calculate total nutrient intake. See a breakdown of protein, iron, vitamin C, and more compared to daily recommended values.
[gif goes here]

### [Name of Feature 3]

[short description goes here]
### Ingredient and Nutrient Database

Explore a library of ingredients and their nutritional content. Each ingredient is linked to multiple recipes and nutrients, helping users understand what they are eating.
[gif goes here]


### [ADDITIONAL FEATURES GO HERE - ADD ALL FEATURES HERE IN THE FORMAT ABOVE; you will check these off and add gifs as you complete them]

## Installation Instructions
Expand Down