Food Truck Tracker

Lambda School Build-week Project

This is the backend for the Food Truck Tracker web application.

The Food Truck Tracker Project:

• Backend:
  • Postman Documentation: https://documenter.getpostman.com/view/11274891/SztD4n16?version=latest
  • Repo: https://github.com/2foodtrucktrackr/backend
  • Base URL: https://foodspy.herokuapp.com/

Database Schema

API Information

• To return food trucks of a specific cusine type, use a query string in the URL, example:

  • /api/trucks?cuisineType=soup

• User registration POST request JSON object example:

  {
    "username": "uniqueUser",
    "password": "passwordString",
    "email": "email@address.com",
    "operator": false,
    "diner": true
  }
  

• User profile POST request JSON object example:

  {
    "firstName": "First",
    "lastName": "Last",
    "profileImageUrl": "string", // or null
    "currentStreetAddress": "123 Profile St.",
    "currentCity": "Profileville",
    "currentState": "PA",
    "currentZipCode": 19147,
    "radSize": 6,
    "bio": "string" // or null
  }
  

• Food truck POST request JASON object example:

  {
    "user_id": 10,
    "truckName": "Truck Name String",
    "imageOfTruck": "URL string", // can be null
    "cuisineType": "cuisine string"
  }
  

• Menu item POST request JSON object example:

  {
    "itemName": "Item Name String!",
    "itemDescription": "Item description string",
    "itemPhotos": "URL String", // or null
    "itemPrice": 4.88,	// numer required
    "customerRatings": [66, 78, 74],	// or null
    "customerRatingAvg: 72.6667 // or null
  }
  

• Location POST request JSON object example (all 'next...' keys are optional):

  {
      "currentLocationDescription": "Penn Treaty Park",
    "currentStreetAddress": "1301 N Beach St",
    "currentCity": "Philadelphia",
    "currentState": "PA",
    "currentZipCode": 19125,
    "currentDepartureTime": "2020-05-30 18:00:00 -5:00",
    "nextLocationDescription": "Clarke Park",
    "nextStreetAddress": "4398 Baltimore Ave",
    "nextCity": "Philadelphia",
    "nextState": "PA",
    "nextZipCode": 19104,
    "nextArrivalTime": "2020-05-31 12:00:00 -5:00",
    "nextDepartureTime": "2020-05-31 18:00:00 -5:00"
  

}

### Endpoints

| ACCESS        | Method | URL           | TESTED |
| :------------ | :----- | :------------ | :----- |
| Login as user | POST   | /api/login    | ✅     |
| Add a user    | POST   | /api/register | ✅     |

| USERS                   | Method | URL                           | TESTED |
| :---------------------- | :----- | :---------------------------- | :----- |
| Get a list of users     | GET    | /api/users                    | ✅     |
| Get a list of diners    | GET    | /api/users/diners             | ✅     |
| Get a list of operators | GET    | /api/users/operators          | ✅     |
| Add a user profile      | POST   | /api/users/:id                | ✅     |
| Get a user profile      | GET    | /api/users/:id                | ✅     |
| Edit a user profile     | PUT    | /api/users/:id                | ✅     |
| Delete a user           | DELETE | /api/users/:id                | ✅     |
| Get a favorite trucks   | GET    | /api/users/:id/favoriteTrucks | ✅     |
| Get a owned trucks      | GET    | /api/users/:id/trucksOwned    | ✅     |

| TRUCKS              | Method | URL                                   | TESTED |
| :------------------ | :----- | :------------------------------------ | :----- |
| Add truck           | POST   | /api/trucks                           | ✅     |
| Get trucks          | GET    | /api/trucks                           | ✅     |
| Get truck           | GET    | /api/trucks/:id                       | ✅     |
| Edit truck          | PUT    | /api/trucks/:id                       | ✅     |
| Delete trucks       | DELETE | /api/trucks/:id                       | ✅     |
| Add truck menu      | POST   | /api/trucks/:id/menu                  | ✅     |
| Get truck menu      | GET    | /api/trucks/:id/menu                  | ✅     |
| Edit truck menu     | PUT    | /api/trucks/:id/menu/:item_id         | ✅     |
| Delete truck menu   | DELETE | /api/trucks/:id/menu/:item_id         | ✅     |
| Add truck location  | POST   | /api/trucks/:id/location              | ✅     |
| Edit truck location | PUT    | /api/trucks/:id/location/:location_id | ✅     |