Skip to content

Brave-squirrels/CodersCamp2020.Project.JavaScript.RestaurantsAPI

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

RestaurantsAPI by BraveSquirrels

Table of Contents

General Info


Here and today, my dear, you are a witness of something new being created... A Brave Squirrels Team first ever project. We created a Restaurants-API Single-page web app, all you have to do, is type in the name of city you are intrested in, for that You will be rewarded with a list of best restaurants in that city!

WARNING We can not assure you that your city is going to be available. We are limited by zomato.api, our JSON dealer :)

Technologies


Project is created with:

  • HTML5
  • SCSS
  • JavaScript
  • Node.js
  • Node-Fetch

Requirements


If you would like to simply visit our webpage, just move on to Setup and look for a URL :)

To be able to run our project locally, you need to have installed npm package manager If you do not know if you have it installed on your computer and you still want to run our project follow these steps:

Windows command prompt/Linux bash

Run npm -v
  • If you received a number like 'x.x.x' you already have installed npm package manager on your computer and you can follow the next part, which is installing parcel
  • Otherwise, you will have to install it, the best way to do it is installing it globaly by running the command npm install npm@latest -g
  • After that you can run again the command from the first line just to confirm that you have succesfully installed required package manager
Install parcel
  • To install parcel appllication bundler run the commnad npm install -g parcel-bundler

Setup


If you want to visit our webpage, just click here! WARNING Github will not open this link in a new tab, you have to do it manually.

To run the project locally follow these steps:

  • Clone this repository
  • Open repository in your code editor
  • Run command npm run prod
  • Run command npm run dev
  • Enter the local host that was created which by default is http://localhost:1234/

Walkthrough


Resources