Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rudrajiii/recipe-app
This is Recipe Generator app . By using this you can generate your own any favourite recipes . it uses LLAMA3-8b llm model by the help of GROQ API that generate's quick response's . For More Visit the repo!!
https://github.com/rudrajiii/recipe-app
ejs-templates expressjs javascript mongodb-atlas nodejs nodemailer recipe-app render scss vscode
Last synced: 4 days ago
JSON representation
This is Recipe Generator app . By using this you can generate your own any favourite recipes . it uses LLAMA3-8b llm model by the help of GROQ API that generate's quick response's . For More Visit the repo!!
- Host: GitHub
- URL: https://github.com/rudrajiii/recipe-app
- Owner: Rudrajiii
- Created: 2024-05-08T13:56:10.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2024-10-12T11:14:53.000Z (about 1 month ago)
- Last Synced: 2024-11-15T11:17:33.390Z (4 days ago)
- Topics: ejs-templates, expressjs, javascript, mongodb-atlas, nodejs, nodemailer, recipe-app, render, scss, vscode
- Language: JavaScript
- Homepage: https://recipe-app-iq01.onrender.com/
- Size: 20.1 MB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Recipe-App ~
It's basically a Recipe Generation wep app using the LLM Model mixtral-8x7b-32768
Provided by GROQ API✨It's Very Very Fast
Here it's Stats From official GROQ WEbSite
## Performance Metrics
### Round Trip Time
- 1.26s
### Model
- mixtral-8x7b-32768
### Detailed Metrics
| Metric | Input | Output | Total |
|----------------------|-------|--------|-------|
| Speed (Tokens/s) | 1235 | 629 | 655 |
| Tokens | 22 | 251 | 273 |
| Inference Time (s) | 0.02 | 0.40 | 0.42 |
Tech Stack 👀
✅Frontend : Ejs , Scss , Bootstrap, Vanilla Js
✅ Backend : Node & Express Js
# Recipe.in
The core idea behind Recipe.in is to generate delicious recipes with just one simple prompt. It's designed to make cooking fun and easy for everyone, from beginners to seasoned chefs.
## Table of Contents
- [Introduction](#introduction)
- First Look ⚡
- 
- Main Dashboard ⭐
- 
- Response Generation ✅
- 
- [Features](#features)
- [Technologies Used](#technologies-used)
- [Installation](#installation)
- [Usage](#usage)
- [API Endpoints](#api-endpoints)
- [Contributing](#contributing)
- [License](#license)
- [Contact](#contact)
## Introduction
Recipe.in is an innovative application designed to generate delicious recipes with just one simple prompt. It's designed to make cooking fun and easy for everyone, from beginners to seasoned chefs.
## Project Structure
GROQ_WITH_NODE/
├── model/
│ ├── SearchHistory.js
│ ├── user.js
│ └── userFeedbacks.js
├── public/
│ ├── images/
│ ├── styles/
│ └── javascripts/
├── views/
├── server.js
├── app.js
├── env.js
├── package.json
└── README.md
## Features
- **User Authentication**: Powered by Passport.js, ensuring secure and smooth user login and registration.
- **User Dashboard**: Clean and simple UI where users can input prompts and get quick recipe suggestions using the incredibly fast Groq API (629 tokens/sec!).
- **History Section**: Stores all user prompts in our MongoDB collection for easy reference and inspiration.
- **Feedback Support**: Users can provide feedback on their experience, with a toast notification confirming submission.
- **Profile Management**: Basic CRUD operations for user profiles, with flash messages for successful and error notifications.
## Technologies Used
- **Frontend**: EJS templating, SCSS, Bootstrap, Vanilla JavaScript
- **Backend**: Node.js, Express.js
- **Database**: MongoDB with collections for Users, Search History, and User Feedback
### Notable Packages
- `passport.js` for authentication
- `nodemailer` for sending registration emails
- `connect-flash` for flash messages
- `mongoose` for database interactions
- `groq-sdk` for fast response generation
### Special Features
- **Demo Prompts**: Predefined prompts for users to test the app instantly.
- **Registration Email**: Successful registrations trigger an email, handled via Nodemailer's fake SMTP server.
## Installation
Follow these steps to set up the project locally:
```bash
# Clone the repository
git clone https://github.com/Rudrajiii/Recipe-App
# Navigate to the project directory
cd Recipe-App
# Install dependencies
npm install -y
# (Optional) Set up environment variables
cp .env.example .env
# Edit the .env file to include your environment variables
# Start the development server
nodemon server.js
# or use your own script to run the server
npm run dev
## API Endpoints
### GET /
- **Description**: Renders the authentication page.
- **Request Params**: None
- **Response**: HTML page for user authentication.
### GET /index
- **Description**: Renders the main user dashboard. Requires user to be logged in.
- **Request Params**: None
- **Response**: HTML page showing user dashboard with recent search history and profile information.
### GET /verify
- **Description**: Renders the verification page for user login.
- **Request Params**: None
- **Response**: HTML page for user verification.
### POST /register
- **Description**: Registers a new user and uploads profile picture if provided.
- **Request Params**:
- `username` (string) - required
- `email` (string) - required
- `password` (string) - required
- `profilePic` (file) - optional
- **Response**: Redirects to the user dashboard upon successful registration.
### POST /login
- **Description**: Authenticates the user and logs them in.
- **Request Params**:
- `username` (string) - required
- `password` (string) - required
- **Response**: Redirects to the user dashboard upon successful login or to the verification page upon failure.
### GET /logout
- **Description**: Logs the user out and redirects to the verification page.
- **Request Params**: None
- **Response**: Redirects to the verification page.
### GET /api
- **Description**: Retrieves a generated recipe based on the user's prompt.
- **Request Params**:
- `prompt` (string) - required
- **Response**:
```json
{
"response": "Generated recipe based on the prompt"
}