Skip to content

README.md

Latest commit

 

History

History
72 lines (57 loc) · 2.13 KB

README.md

File metadata and controls

72 lines (57 loc) · 2.13 KB

Nutrify

🥗 Nutrify is a full-stack web application designed to help households manage their pantry, track ingredient inventory, and find recipes based on available ingredients. It integrates with the Spoonacular API to fetch nutrition information and recipe suggestions.

Table of Contents

Features

  • User authentication: Register and login
  • Create or join a household
  • Add, edit, and delete pantry items
  • Fetch ingredient nutrition information via Spoonacular API
  • Find recipes using existing ingredients
  • Dashboard showing total items, fresh items, and items expiring soon
  • Interactive inventory and recipe cards

Project Structure

nutrify/
│
├─ backend/
│ ├─ config/           # Database config and other configurations
│ ├─ node_modules/     # Node.js dependencies (do NOT push to GitHub)
│ ├─ src/
│ │ ├─ server.js       # Main server file
│ │ └─ routes/         # API routes (auth, household, ingredients, recipes)
│ ├─ schema.sql        # SQL schema to set up the database
│ ├─ package.json      # Project dependencies and scripts
│ ├─ package-lock.json # Locked dependency versions
│ └─ .env              # Environment variables (do NOT push this)
│
├─ frontend/
│ ├─ pages/            # HTML pages
│ ├─ css/              # Stylesheets
│ └─ js/               # JavaScript files
│
├─ .vscode/            # VSCode config files
└─ README.md           # Project documentation

Technologies Used

  • Backend: Node.js, Express.js
  • Frontend: HTML, CSS, JavaScript
  • Database: MySQL
  • APIs: Spoonacular API for ingredients and recipes
  • Version Control: Git / GitHub

Setup Instructions

1. Clone the repository

git clone https://github.com/MohsinN05/nutrify.git
cd nutrify/backend