Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/smallpaes/restaurant-list
A web application built with Node.js and Express to display a list of restaurants with detail and offer the searching function to help readily locate the ideal restaurants.
https://github.com/smallpaes/restaurant-list
Last synced: 24 days ago
JSON representation
A web application built with Node.js and Express to display a list of restaurants with detail and offer the searching function to help readily locate the ideal restaurants.
- Host: GitHub
- URL: https://github.com/smallpaes/restaurant-list
- Owner: smallpaes
- Created: 2019-06-06T05:27:18.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2022-12-10T18:20:12.000Z (almost 2 years ago)
- Last Synced: 2023-03-03T02:21:23.058Z (over 1 year ago)
- Language: CSS
- Homepage:
- Size: 14.8 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Restaurant List
A web application built with Node.js and Express to display a list of restaurants with detail and offer the searching function to help readily locate the ideal restaurant.
## Project First Look
## Features
| Functions | Detail | URL |
| ---------------------- | ------------------------------------------------ | --------------------------- |
| View all restaurants | Click on logo to find name, image, category, rating of all restaurant | / |
| View restaurant detail | Click on any restaurant card to view address, phone number, category, description, image | /restaurants/:restaurant_id |
| Search restaurants | Input name in search bar to find matching restaurants | /search |
## Installation
The following instructions will get you a copy of the project and all the setting needed to run it on your local machine.
### Prerequisites
- [Node.js](https://nodejs.org/en/download/)
### Clone
Clone this repository to your local machine
```
$ git clone https://github.com/smallpaes/restaurant-list.git
```
### Setup
1. Enter the project folder
```
$ cd restaurant-list
```
2. Install npm packages
```
$ npm install
```
3. Activate the server
```
$ npm run dev
```
4. Find the message for successful activation
```
Express is listening on http://localhost:3000
```
You may visit the application on browser with the URL: http://localhost:3000
## Authors
[Mike Huang](https://github.com/smallpaes)