Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap

About The Project

REST API to make complex searches from a collection of Restaurants and purchase a dish for a User

Main Features:

• List all restaurants that are open at a certain datetime
• List top y restaurants that have more or less than x number of dishes within a price range
• Search for restaurants or dishes by name, ranked by relevance to search term
• Process a user purchasing a dish from a restaurant, handling all relevant data changes in an atomic transaction

(back to top)

Built With

• Node.js
• Express.js
• MongoDB.js
• TypeScript

(back to top)

Getting Started

The app is deployed and is hosted in https://omar-buying-frenzy.herokuapp.com. You can make api calls from this this link to test it out. If you want to test it right away, scroll down to Usage section.
Or, if you want to run it in your own local machine, scroll down to Prerequisites section.

Prerequisites

• MongoDB atlas account (use mine if you don't have one)
• MongoDB atlas URI (use mine if you don't have one)
• Latest LTS version of Node.js installed in local machine
• npm or yarn installed in local machine
• git installed in local machine
• TypeScript installed in local machine

Installation

Be sure to follow the Prerequisites steps mentioned above

1. Clone this repository:

   git clone https://github.com/hotmailbelike/abdullah-omar-backend-11Mar2022.git
   

2. Open the folder in terminal

3. Install NPM packages

   npm i 
   

   or

   yarn 
   

4. Create .env file in the root of the project

5. Add the line MONGODB_URL=YOUR MONGO DB ATLAS URI in the .env file.
   Note: if you don't want to use your own YOUR MONGO DB ATLAS URI or if you don't have one, you can use mine and skip the next step

6. Run in development mode: npm run dev or yarn dev. App will run on Port 5000 (localhost:5000)
   Note: if there are errors, be sure to delete all lock files and node_modules folder and install NPM packages again (See command from Step 1)
   My Mongo DB Atlas URI: mongodb+srv://user_1:user1234@cluster0-vq45a.mongodb.net/Buying_Frenzy_DB?retryWrites=true&w=majority

7. (Skip this step if you are not using your Mongo DB Atlas URI)
   Populate your database with sample restaurant and user data provided. Make a POST api call to the route /api/restaurant/populate and wait until you get a "Database populated!" message. fetch example:

fetch('localhost:5000/api/restaurant/populate',{method:"post"})
	.then((res) => res.json())
	.then((res) => {
		console.log('🚀 -> res', res);
	})
	.catch((error) => {
		console.error('🚀 -> error', error);
	});

REST client example:

8. If there are no errors, you are finally ready to test the app locally from your machine.

(back to top)

Usage

This section contains list of apis available and how to use them with example.
As mentioned earlier the app is already hosted in https://omar-buying-frenzy.herokuapp.com, use this has host when making api calls.
If you have the app running and ready in your local machine and want to make requests from there then use localhost:5000 as host when making api calls

• List all restaurants that are open at a certain datetime

api: POST /api/restaurant/search/isOpen
body: timeString
(optional) query params: page, limit

Note: timeString in reqest body must follow the format: "DDD HH:MM am/pm" e.g "Mon 12:30 pm" page will skip results and limit will set limit to number of results return

fetch example:

fetch('/api/restaurant/search/isOpen?page=0&limit=10', {
	method: 'post',
	headers: {
		Accept: 'application/json',
		'Content-Type': 'application/json',
	},
	body: JSON.stringify({ timeString: 'Sun 5:30 am' }),
})
	.then((res) => res.json())
	.then((res) => {
		console.log('🚀 -> res', res);
	})
	.catch((error) => {
		console.error('🚀 -> error', error);
	});

REST client example:

---

• Search for restaurants or dishes by name, ranked by relevance to search term

api: POST /api/restaurant/search/restaurantOrDish
body: restaurantOrDishName

fetch example:

fetch('/api/restaurant/search/restaurantOrDish', {
	method: 'post',
	headers: {
		Accept: 'application/json',
		'Content-Type': 'application/json',
	},
	body: JSON.stringify({ restaurantOrDishName: 'Fish' }),
})
	.then((res) => res.json())
	.then((res) => {
		console.log('🚀 -> res.dishes', res.dishes);
                console.log('🚀 -> res.restaurants', res.restaurants);
	})
	.catch((error) => {
		console.error('🚀 -> error', error);
	});

REST client example:

---

• List top y restaurants that have more or less than x number of dishes within a price range

api: POST /api/restaurant/search/priceRange
body: {
  restaurantLimit: limit number of restaurants to fetch, 
  moreOrLess: eiter "more" or "less" to indicate more than dishLimit or less than dishLimit,
  dishLimit: how many dishes to limit per restaurant,
  priceUpperLimit: dish price max limit,
  priceLowerLimit: dish price min limit,
}

Example 1: List top 10 restaurants with less than or equals to 5 dishes within price 20 and 10 fetch:

fetch('/api/restaurant/search/priceRange', {
	method: 'post',
	headers: {
		Accept: 'application/json',
		'Content-Type': 'application/json',
	},
	body: JSON.stringify({ 
	    restaurantLimit : 10,
            moreOrLess : "less",
            dishLimit : 5,
            priceUpperLimit :  20,
            priceLowerLimit :  10
	}),
})
	.then((res) => res.json())
	.then((res) => {
		console.log('🚀 -> res', res);
	})
	.catch((error) => {
		console.error('🚀 -> error', error);
	});

REST client example:

Example 2: List top 50 restaurants with more than or equals to 7 dishes within price 12 and 5

fetch:

fetch('/api/restaurant/search/priceRange', {
	method: 'post',
	headers: {
		Accept: 'application/json',
		'Content-Type': 'application/json',
	},
	body: JSON.stringify({ 
	    restaurantLimit : 50,
            moreOrLess : "more",
            dishLimit : 7,
            priceUpperLimit :  12,
            priceLowerLimit :  5
	}),
})
	.then((res) => res.json())
	.then((res) => {
		console.log('🚀 -> res', res);
	})
	.catch((error) => {
		console.error('🚀 -> error', error);
	});

REST client example:

---

• Process a user purchasing a dish from a restaurant, handling all relevant data changes in an atomic transaction

api: POST /api/user/purchaseDish/:userId
body: {
restaurantId : mongo db id of the restaurant
dishName: fill dish name
}
param: userId: mongodb id of the user

Example: Christopher Deisher whose _id is 622f64e59c2e631c97749448, is purchasing dish: rote schweizer weine from 13 Coins whose _id is 622f649f9c2e631c97741688

fetch:

fetch('/api/user/purchaseDish/622f64e59c2e631c97749448', {
	method: 'post',
	headers: {
		Accept: 'application/json',
		'Content-Type': 'application/json',
	},
	body: JSON.stringify({ restaurantId: '622f649f9c2e631c97741688', dishName:'rote schweizer weine' }),
})
	.then((res) => res.json())
	.then((res) => {
		console.log('🚀 -> res.user', res.user);
                console.log('🚀 -> res.restaurant', res.restaurant);
	})
	.catch((error) => {
		console.error('🚀 -> error', error);
	});

REST client:

Roadmap

• Create APIs
• Deploy to Heroku
• Set up test codes
• Switch to SQL database

(back to top)