Skip to content

Ingrediate is an application for generating custom recipes based on validated, user inputted ingredients.

Notifications You must be signed in to change notification settings

jojecameron/Ingrediate-App

Repository files navigation

Ingrediate

TypeScript JavaScript Express.js ChatGPT Node.js Postgres Firebase Cypress Jest React SASS Shell Prettier

About

Ingrediate is an open-source application for generating custom recipes based on validated, user inputted ingredients.

Simply type in the contents of your fridge/pantry, choose a meal type you would like to make, select a recipe generation model, and generate! Ingrediate supports persistent data through user authentication with Firebase, and PostgreSQL.

Demo


Installation

Prerequisites

  1. For use of Open Source LLM's within the application, download and install Ollama, and make sure you have both mistral:7b and llama2 downloaded locally.
  2. Ingrediate can also generate custom recipes with the paid OpenAI API service, you must have an account and your own personal API key to use. This will only apply if you want to use the text-davinci-003 model in the application.
  3. You must also have a PostgreSQL database instance with a connection string to be able to persist favorited recipes to the database.
  4. Finally, for user authentication you should set up a Firebase instance with a Web API key.

How to use

  1. Fork and clone this repo.

  2. cd to the root directory run npm install

  3. Create a .env in server following the .env.example.
    # Do not share your OpenAI API key with anyone! It should remain a secret.
    OPENAI_API_KEY=
    PORT=
    PG_URI=
    NODE_ENV=
    FIREBASE_API_KEY=

  4. Paste in your OpenAI API & Firebase API key for user auth, PG_URI connection string, and port to run your server.

  5. Run npm run dev, ollama will launch, the development server and client will run concurrently, and Ingrediate will open in your web browser!

Author

Developed By Github LinkedIn
Johanna Cameron Github LinkedIn

About

Ingrediate is an application for generating custom recipes based on validated, user inputted ingredients.

Resources

Stars

Watchers

Forks