Skip to content

"Sue" is derived from and a shortened version of "Sous Chef." If the executive chef in you needs some recipe inspiration, just ask your assistant, Sue.

Notifications You must be signed in to change notification settings

Eddie-OConnor/Sue

Repository files navigation

Sue

Project Description

"Sue," derived from and shortened for "Sous Chef," is your culinary companion that suggests personalized recipes after you answer a brief six-question survey. Say goodbye to meal planning uncertainty and elevate your home cooking game with Sue's tailored recommendations, introducing you to dishes you might not have discovered on your own. For recipe inspiration, turn to Sue, your trusty assistant, and let the executive chef within you shine.

Technologies Used

  • Frontend: HTML, JS, CSS (mobile first, responsive design), Vite
  • Backend: Netlify
  • AI Models: OpenAI (Assistant, Function/Tools, GPT, DALL-E)
  • APIs: SERP API, Cloudinary CDN

Installation Instructions

  1. Clone the repository
    git clone https://github.com/your-username/sue.git
    cd sue
  2. Connect repo to Netlify netlify cli
  3. Install dependencies npm install
  4. Add OPENAI_API_KEY, SERP_API_KEY, and asstId as environment variables
  5. Create assistant by referencing assistant-build.txt
  6. Add asstId as environment variable

Usage

  1. Complete form of questions
  2. Click submit
  3. Review returned recipes, clicking the tile if you'd like to learn more and cook
  4. Reset button to submit a new request

Future Improvements

We will add in an allergies and dislikes question for Sue to process in order to avoid recommending recipes that a user cannot eat or will not like. This was included in the initial build; however, the assistant could not handle the complexity. This feature can be added in when OpenAI Assistant is more advanced and out of beta or when GPT model improvements are released.

Contributing

Contributions are welcome! Please follow these guidelines:

  • Fork the repository.
  • Create a new branch: git checkout -b feature/new-feature
  • Make your changes and commit them: git commit -m 'Add new feature'
  • Push to the branch: git push origin feature/new-feature
  • Submit a pull request.

Credits

License

This project is open source. License details

Contact Information

About

"Sue" is derived from and a shortened version of "Sous Chef." If the executive chef in you needs some recipe inspiration, just ask your assistant, Sue.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published