Restaurant List A1

General Info 👋

This is a simple restaurant list web application. Users can see the list of restauants, access details of the restaurants, and also search for the style or the name of a restaurant.

Features

  • List of restaurants with brief introduction.
  • Showing detailed information of restaurants.
  • Links to help users find out the location via google map.
  • Searching restaurants by the name of a restaurant or the type of a restaurant

Technologies 💡

Project is created with:

  • Node.js v16.14.0
  • Express 4.16.4
  • Express tool - Handlebars 3.0.0
  • Bootstrap 4.3.1
  • Font-awesome 5.8.1

Setup 🔌

Please follow the instructions listed below to access the project:

1. Required environment

Before getting this project up and running locally, you should start by having node.js installed on your computer. It's required to create a Node.js environment to run the project successfully.

2. Clone the repository

Run the following command in a terminal (mac/linux) or windows terminal:

git clone https://github.com/JulieDeveloper/A1_Restaurant_List.git

3. Install npm kit

Run the following command in the base directory of this project in the terminal:

npm install

4. Launch the project

Run the following command in the base directory of this project in the terminal:

npm run start

5. Completed

The installation is completed once you received the message on the terminal as:

"Express is now listening to localhost:3000"

6. Access to the browser

To display the project on your browser, ckick in the link: http://localhost:3000

7. Terminate the project

To turn off the project by simply pressing Ctrl+C in the terminal once you're done.