👨‍🍳 Geeky Chef

Geeky Chef is your ultimate nutrition companion, designed to make meal preparation easier by helping you discover personalized recipes, plan meals, and analyze nutrition with AI-driven recommendations.

📑 Table of Contents

• 🚀 Tools & Technologies
• 📋 Project Management
• 🩺 Project Status
• 🌐 Live Demo
• 📺 Youtube Demo
• 👥 Team Members & Mentor
• 📘 API Documentation
• 💻 Tech Stack
• 📜 Project Description
• 🛠️ Getting Started
• 🗺️ ERD

🚀 Tools & Technologies

📋 Project Management

🩺 Project Status

👥 Team Members & Mentor

Team Brain Train members and their respective roles are as follows:

Mostafa Rifat Tazwar

Abdullah Muhammed Amimul Ehsan

Abrar Jahin Sarker

Mohammad Anik Islam Shojib

📘 API Documentation

Backend API documentation is available at:

💻 Tech Stack

Backend
Node	JavaScript runtime for building scalable network applications
Express	Web application framework for Node.js, designed for building APIs
MongoDB	NoSQL database for scalable and flexible data storage
Mongoose	MongoDB ODM for Node.js, providing schema-based data modeling
Firebase	Authentication and image storage
Spoonacular	API for recipe and nutrition data
Gemini	AI for food image recognition and similar food query
Clarifai	AI for food image recognition and ingredient detection
Frontend
React	JavaScript library for building user interfaces
CSS	Stylesheet language for designing web pages
Vite	Frontend build tool for fast and optimized development
Chakra UI	React component library for building accessible and customizable UI
Framer Motion	Animation library for React to create smooth and interactive animations
Testing
Jest	JavaScript testing framework for unit and integration tests
CI/CD
GitHub Actions	Continuous integration and delivery platform for automating workflows
Vercel	Deployment platform for frontend applications
Security
Dependabot	Automated dependency management tool to keep dependencies secure
CodeQL	Automated code analysis to identify vulnerabilities
Snyk	Security platform for finding and fixing vulnerabilities in code
SonarCloud	Continuous inspection platform for code quality and security
GitGuardian	Security tool to monitor code repositories for sensitive data leaks

📜 Project Description

Geeky Chef is an innovative platform that leverages cutting-edge technologies to simplify meal preparation and enhance the cooking experience. With features like personalized recipe recommendations, meal planning, and nutritional analysis powered by AI, Geeky Chef is designed to cater to diverse dietary preferences and lifestyles. Whether you're a seasoned chef or a beginner, Geeky Chef is your go-to solution for smarter and healthier cooking. 🍳✨

• 🍴 Recipe Discovery Module

  • Personalized recipe recommendations based on user preferences and dietary restrictions.
  • User search history based recipe suggestions.
  • Recipe filtering based on ingredients, cuisine, and dietary needs.

• 🗓️ Meal Planning Module

  • Weekly meal planning with customizable options.
  • Integration with shopping lists for efficient grocery management.

• 🧪 Nutritional Analysis Module

  • Detailed nutritional breakdown of recipes and meals.
  • AI-driven nutrition analysis.

• 📸 Food Recognition Module

  • Image-based food recognition for identifying ingredients and dishes.
  • AI-powered similar food query for exploring related recipes.

• 🔒 User Management Module

  • Secure user authentication and profile management.
  • Personalized dashboards for tracking meal plans and favourite recipes.

• 📊 Analytics & Insights Module

  • Insights into dietary habits and nutritional goals.
  • Visual reports for tracking progress over time.

🛠️ Getting Started

Follow these steps to set up the project locally:

1. Clone the Repository
   Clone the repository to your local machine:

git clone https://github.com/Learnathon-By-Geeky-Solutions/brain-train.git

2. Navigate to the Project Directory
   Move into the project directory:

cd brain-train

3. Install Dependencies
   Install the required dependencies for both the backend and frontend:

# Backend dependencies
cd backend && npm install

# Frontend dependencies
cd ../frontend && npm install

# Return to the root directory
cd .. && npm install

4. Set Up Environment Variables Create .env files in both backend and frontend directories. Refer to their respective .env.example and .env.example files for required variables.

5. Start the Application
   Use concurrently to start both the backend and frontend:

npm start

Your application should now be running locally. Open your browser and navigate to the specified URL to access the application.