CookBot-AI

Table of Contents

1. About The Project
   • Note
2. Demo
3. Features
4. Technologies
5. UML Diagram
6. Installation
   • Prerequisites
   • Cloning the Repository
   • Configure
   • Start
7. Contact

About The Project

The CookBot AI Recipe Project is a web application designed to assist users in managing and exploring recipes. It leverages the power of artificial intelligence to simplify the process of creating, organizing, and discovering new recipes. Whether you're a cooking enthusiast, a culinary expert, or just looking for meal inspiration, CookBot AI offers a user-friendly platform to streamline your cooking experience.

Note

This is a forked repository of my team project that was developed with 2 other teammates. I was a key contributor for this project. See below for old version of the application.

• Old CookBotAI Repo

(back to top)

Demo

Here's the live link: CookBot AI

(back to top)

Features

• User Authentication: Securely register and log in using authentication services.
• Recipe Management: Create, read, and delete your recipes with ease.
• AI-Generated Content: Access AI-generated images and content for your recipes.
• Responsive Design: Enjoy a seamless experience on various devices.

(back to top)

Technologies

• Frontend: React.js for a dynamic and interactive user interface.
• Backend: Node.js and Express.js for server-side logic.
• Database: MongoDB for storing recipe data.
• Authentication: Auth0 for user authentication.
• OpenAI Integration: Chat Completions API for recipe generation and DALL·E‍ API for image generation.
• Additional Libraries and Frameworks: React Bootstrap, MUI icons.

(back to top)

UML

(back to top)

Installation

Prerequisites

Before you begin, ensure you have the following installed:

• Node.js (preferably the latest stable version)
• npm (usually comes with Node.js)
• Git for cloning the repository
• A text editor or IDE of your choice (e.g., VSCode, Sublime Text)

Cloning

This is for the backend portion of this application. See the following readme file for frontend portion: CookBot APP

1. git clone https://github.com/cleecoloma/cookbot-ai-api.git
2. cd cookbot-ai-api
3. npm install

Configure

OPEN_AI_URL={OpenAI Chat Completion Endpoint}
OPEN_AI_IMAGE_URL={OpenAI Image Generation Endpoint}
MONGODB_URL={MongoDB Atlas Cluster Connection String}
JWKS_URI={Auth0 JSON Web Key Set}
OPENAI_API_KEY={OpenAI API Key}

Start

1. npm run dev (development mode)
2. npm run build (production mode)

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

If you have any questions or comments, don't hesitate to reach out to me at chesterleecoloma.com.

(back to top)