Kitchen Quest

An application for discovering recipes based on the ingredients a user has utilizing the spoontacular API., Feb 2020

By Team Kitchen Quest

Description

MVP:

Users can enter the ingredients they have in their fridge and the application will provide a list of recipes that consist of the inputted ingredients, as well as a list of additional ingredients they will need to successfully create the suggested recipes. Users can search recipes to find cooking instructions. Lastly, users can click on fridge graphic for a food related fact.

Preview

Project Specifications

Behavior	Input	Output
User inputs the ingredients they have and clicks submit to recieve recipe inspiration	apple, sugar, flour	Apple fritter
User inputs recipe name to recieve recipe instructions	apple fritter	Combine flour, sugar, salt, baking powder, cinnamon. Stir in milk and egg until just combined. Fold in apple...
User clicks on fridge graphic to recieve a food related fact	graphic click	Cherries are in the rose family

Setup/Installation Requirements

In Terminal:

Navigate to where you want this application to be saved, i.e.: cd desktop
Clone the file from GitHub with HTTPS git clone https://github.com/benjamin-thompdx/kitchen-quest.git
Open file in your preferred text editor
On Mac: open -a {your text editor} kitchen-quest
On Windows: kitchen-quest
run: npm install

Download Manually:

Navigate to https://github.com/benjamin-thompdx/kitchen-quest.
Click the green "Clone or Download" button.
Click "Download ZIP".
Click downloaded file to unzip.
Open folder called "kitchen-quest".
Right-click "index.html" and select your preferred browser or text editor.

Note For Editors:

Once cloned/downloaded, to run and make changes, in the terminal simply run $ npm install to download necessary dependencies
Run $ npm run build to create your dist folder with a bundle.js file
Obtain API key from https://spoonacular.com/food-api
Create .env file in the root directory of kitchen-quest
Add the API keys to .env file (API_KEY = input your API key here)
IMPORTANT Add .env file to .gitignore file
The API key will now be referenced within the kitchen-service.js file using the following syntax: ${process.env.API_KEY}
Lastly, run $ npm run start to run the application

Known Bugs

No known bugs at this time.

Support and contact details

Have a bug or an issue with this application? Open a new issue here on GitHub.

Technologies Used

HTML
CSS
Bootstrap
Javascript
jQuery
Webpack
Node.js
Spoonacular API
Google custom search engine
PixelArt

License

MIT

benjamin-thompdx/kitchen-quest