Skip to content

ragavik/cook-better

Repository files navigation

Cook Better Bot

Cook Better is a Slack chat bot that recommends recipes based on available ingredients, and user's dietary and health restrictions.

Demo

cookbetter-1 cookbetter-2

Slash Commands

/personalize

  • Use this command to configure any food allergies, dietary restrictions, your health conditions and weight goals.
  • You only have to do this once and we'll keep your selections in mind whenever you search for recipes!

/searchrecipes

  • Use this command to search for recipes based on the ingredients you have.
  • You can also search recipes by recipe type, cooking time or find recipes for special occasions.

/surpriseme

  • This command suggests a random recipe every time (while keeping in mind your personalization criteria)!

/imagesearch

  • Upload a photo of the ingredients you have & type this command to get recipes.
  • Note: The last image you uploaded will be used for searching for recipes. If timeout occurs, try again in a while.

/suggest

  • Use this command to search for recipes using natural language.
  • Example: /suggest Show me chicken recipes
  • Example: /suggest onion, tomato, chicken

/recipestats

  • Use this command to get statistics of our recipes.

/addcomment

  • Example: /addcomment {Recipe Name} Your comment..

/cookbetterhelp

  • Come back to this space in case you get stuck and to watch out for any new features we might add!

Note

  • To test the chat bot join this workspace and try out the slash commands.

Instructions

Follow these instructions to set up the development environment on your local machine.

Prerequisites

  • JDK
  • IntelliJ IDEA
  • Gradle
  • Amazon Web Services

Development Environment

STEP 1: Download and install Java SE Development Kit from here.

STEP 2: Download and install Intellij IDEA from here.

STEP 3: Download Gradle build tool from here and follow these instructions for installation.

STEP 4: Clone the repository to your local machine. Open the project in Intellij IDEA. While importing the project, make sure to point to the right Gradle installation folder on your machine.

Run the Application

To run the application on your local machine, execute the following command in the terminal.

gradle build

Check out the service.

$ curl localhost:8080

Deployment

Execute the following command in the terminal.

gradle bootRun

The WAR file for the project will be generated in the folder /build/libs. Deploy the WAR file on Amazon Web Services by following these instructions.

About

A Slack chat bot for personalized recipe recommendation.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages