Skip to content

README.md

Latest commit

 

History

History
48 lines (28 loc) · 1.47 KB

README.md

File metadata and controls

48 lines (28 loc) · 1.47 KB

Kitchen Geek

App Screenshot

Recalculating recipe servings can be time-consuming. A recipe may offer a large serving but you want less. And vice versa.

Kitchen Geek helps people discover recipes based on available ingredients, resize servings, and tracks needed ingredients.

Server Features

This server allows the Kitchen Geek client to store, read, delete and check for bookmarked recipes.

  • All data is stored in a JSON file
  • The client interacts with the JSON file through an API made with Node and Express.

Installation

Server

  1. Clone or download this project (Click the green code dropdown above).
  git clone https://github.com/Pensive1/KitchenGeek.git
  1. Open your terminal and install NodeJS. If you have node, please skip this step.
  npm install npm@latest -g

  1. In your terminal or code editor, browse into the folder.

  2. Run npm install to download the necessary packages

  npm install

Note: This project requires API details in a .env file. Send me an email for details, fill in the quotes then rename .env.example to .env.

  1. Once complete, type npm start to run the server.

Note: The server must run at all times for Kitchen Geek to run effectively.

Client

Head back to the client repo to continue installation.