README.md

TastyByte, a Foodie Social Network

AD410 Project by Alex Sutherland, Andy Wilson, Paul Briones, Phil Kim

Welcome to TastyByte 🥒🥕🥦🧅🍽️, a social network for foodies to share their favorite recipes. Built with React, Node, Express, and MongoDB.

Deploy Locally

backend folder contains backend Express app. To run this server:

1. open new terminal
2. cd into backend directory
3. run the following command:

   npm install

4. run the following command:

   npm run server

client folder contains frontend React app. To run this server:

1. open new terminal
2. cd into client directory
3. run the following command:

   npm install

4. run the following command:

   npm start

Style Guide

1. ES6 JavaScript (let, arrow functions)
2. Constants are in all caps
3. Components are capitalized
4. Use camelCase whenever possible

API Testing With Postman

The following routes can be used to test and retreive data via Postman:

GET

http://localhost:8080/api/recipe/

Returns all recipe objects

POST

http://localhost:8080/api/recipe/

Insert recipe object into database like below; customize values as desired

{
    "name": "Recipe Name",
    "author": "Recipe Author",
    "description": "Recipe Description",
    "instructions": "Recipe Instructions",
    "ingredients": [
        "Ingredient 1",
        "Ingredient 2",
        "Ingredient 3"
    ],
    "photo": "Photo URL",
    "tags": [
        "tag1",
        "tag2",
        "tag3"
    ]
}