Skip to content

SolivanLau/ai-chef-api

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

AI CHEF 👨‍🍳😙👌

Description

This is AI Chef! Using Open AI API and Digital Ocean Spaces, this project generates recipes steps and images from any user inputted ingredients!

Table of Contents

Project Overview

This server uses the following:

Tech Stack 🤖

  • Node.js: JavaSript runtime for server side projects.
  • Express.js: Framework to simplify server side actions.

Packages 📦

  • nodemon:
  • cors:

API & External Services 🛜

  • Digital Oceans Spaces: Cloud storage without surprises. Spaces is a simple and scalable data storage service.
  • Open AI API: gpt-3.5-turbo: AI model for generating natural language and code.
  • Open AI API: DALLE: AI model for generating images from natural language.

Structure

Files 📄

All files use the .mjs format to benefit from ES6 import syntax. This works in tandem with "type": "module" configuration located in package.json to ensure import syntax works to minimize the amount of imports in the entry file.

Folder 📂

This projects main entry file is located at index.mjs, importing files from 3 key areas:

  1. middleware
  2. route
  3. controller

These directories have their own localized index.mjs files to centralize and forward respective imports.

Installation ⚒️

  1. Clone the repository:
git clone <git-repository>
  1. Run Development Script npm run start-dev

This script will allow you to run a development server set to http://localhost:3000/ with a default port of 3000. Feel free to change the port at the main entry point index.mjs of the application.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published