Cookit! is a single page application that allows user to save and reference recipes from a database and 3rd party websites. This application allows users to cut out the fluff by extracting only the information you need.
The following instructions will get you a copy of the project up and running on your local machine for demonstration and testing purposes.
-
Download and install Node.js
-
Install React with the following terminal command:
npm install --save react
- Install
ReactDOM
with the following terminal command:
npm install --save react-dom
- Install
json-server
with the following terminal command:
npm install -g json-server
-
Get an API key for Spoonacular: Recipe-Food-Nutrition. Do NOT share this API key with anyone else.
-
Clone my repository to your local machine.
-
Navigate to the project folder. In the
src
directory. Within that directory, create a file.api_key.js
-
In said file, copy/paste
export const apiKey = `paste_your_api_key_here`
. This will prevent you from accidentally sharing your API key with other people and allow you to access the API database.
A step by step series of examples that tell you how to get a development env running
- In your terminal, navigate to the project directory.
cd /Users/username/workspace/cookit
- From the root of this directory, run the following terminal command in order to start up the React application.
npm start
- Open a new terminal tab and navigate to the
api
directory.
cd /Users/username/workspace/cookit/api
- Run the following terminal command in order to start up your
json-server
.
json-server -p 8088 -w database.json
-
Open your web browser of choice and navigate to
http://localhost:3000/
-
You will be presented with a login/registration page if this is your first time using the application. Register an account or use my email
h.allen.lester@gmail.com
and password12345
. -
From here you can use the search bar with keywords like "chicken" or "strawberries" and you will be presented with multiple recipes from the Spoonacular API. You can select any of these recipes and be presented with a detailed recipe including ingredients and cooking instructions. If you are looking to parse specific recipe you can click the "Search Bar" drop-down button and select the "Extract Bar". Here, you can paste in recipe URL's from other websites and the essential information will be provided to you. You can save these recipes for later or add them to the meal section. Once the meals are added you can selecte the "Build Grocery List" button and you will be presented with a grocery list of all the recipes selected.
-
Thank you for your time!
- React - A JavaScript library for building user interfaces
- Spoonacular API - A recipe, nutrition, and ingredient API with over 5,000 recipes
- Heath Lester - Original Creator - Heath-Lester
This project has been planned, developed, and tested exclusively by myself over the course of a two-week sprint.
- Thank you to the creator of Spoonacular API, which provided all the recipes for this application as well as additional functionality.