https://github.com/icn2you/fsf-p01
CookQuik is a meal-planning app that allows its users to search for recipes based on dietary preferences and/or restrictions and to optionally specify a list of on-hand ingredients to incorporate.
https://github.com/icn2you/fsf-p01
diet ingredients meal meal-planner recipe
Last synced: about 1 month ago
JSON representation
CookQuik is a meal-planning app that allows its users to search for recipes based on dietary preferences and/or restrictions and to optionally specify a list of on-hand ingredients to incorporate.
- Host: GitHub
- URL: https://github.com/icn2you/fsf-p01
- Owner: icn2you
- Created: 2020-03-25T02:12:14.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-01-07T16:31:37.000Z (almost 3 years ago)
- Last Synced: 2025-07-14T06:52:45.288Z (3 months ago)
- Topics: diet, ingredients, meal, meal-planner, recipe
- Language: JavaScript
- Homepage: https://christopherzenner.dev/fsf-p01/
- Size: 3.97 MB
- Stars: 1
- Watchers: 1
- Forks: 3
- Open Issues: 28
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# CookQuik
## Project Description
We built a recipe app that allows the user to select a diet type (e.g., vegetarian, Kosher, gluten-free, etc.) and optionally specify a list of ingredients.
The app will then use an API call to one/more recipe services to pull back recipes conforming to the specified parameters--that is, diet type and ingredients.
The results will be displayed in an aesthetically pleasing manner using a carousel. When the user selects a particular recipe from the carousel,
the recipe will load full-page and, at the bottom, display a form field that will allow the user to input the number of people to serve.
The app will then calculate the ingredient portions accordingly. Finally, the app will use local storage so the user can persist one/more favorite recipes.
## Summary
The primary goal for this product is to make cooking easier and more efficient by provinding diet specific and allergin complient recipies.
Our target audience comprises of amateur chefs, busy professionals, working moms, etc. hence the 45m alloted cook time and adjustable serving sizes.
## APIs Used
* Spoonacular
* Youtube Data
## Built With
* Lodash
* Materialize
* Math.js
* Node query-string
* Sass
* Webpack
## Deployment/Installing
```javascript
// provide API keys in config/keys.js
const SPOONACULAR_API_KEY = 'spoonacular rapidapi key',
YOUTUBE_API_KEY = 'google api key for youtube data api v3';
export { SPOONACULAR_API_KEY, YOUTUBE_API_KEY };
```
```shell
# install deps and toolchain
npm install
# build frontend
npm run build
```
## Authors
Christopher Zenner, Yuko Uda, Brittany-Renee Davis
## Helpful Links
* [Presentation Slides](https://docs.google.com/presentation/d/1c-VUgYBjS09AjHnAK8YAVp3cPgb_0q0bc6mAjjp2gwg/edit?ts=5e88b77f#slide=id.g72af502572_0_1)
* [Live Demo](https://christopherzenner.dev/fsf-proj-01/)