Skip to content

vanshs64/souschef

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

SousChef - A Recipe App

Overview

Our Recipe App is a user-friendly React application that allows users to input a recipe URL or paste recipe text directly. The app extracts important details such as ingredients, steps, durations, and provides helpful cooking techniques. Users can specify the quantity of the recipe they want and receive step-by-step instructions in a friendly manner.

Features

  • Input a recipe URL or paste recipe text directly.
  • Extracts ingredients, steps, and durations from the provided recipe.
  • Provides AI-generated cooking techniques to simplify the cooking process.
  • Allows users to specify the desired quantity of the recipe.
  • Presents instructions step-by-step to avoid overwhelming users.

Getting Started

Prerequisites

  • Node.js (version 14 or higher)
  • npm (Node Package Manager)

Installation

  1. Clone the repository:
    git clone <repository-url>
    
  2. Navigate to the project directory:
    cd my-react-app
    
  3. Install the dependencies:
    npm install
    

Environment Variables

Create a .env file in the root of the project and add your OpenAI API key:

REACT_APP_OPENAI_API_KEY=your_api_key_here

Running the Application

To start the development server, run:

npm start

Open your browser and navigate to http://localhost:3000 to view the application.

Building for Production

To create a production build, run:

npm run build

Usage

  1. On the home page, input a recipe URL or paste the recipe text.
  2. Specify the quantity of the recipe you want.
  3. Follow the step-by-step instructions provided by the app.

Contributing

A hackathon project created by Aizah, Vansh, Vishnu and Simon welcomes contributions! Please open an issue or submit a pull request for any enhancements or bug fixes.

License

This project is licensed under the MIT License.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors