Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/smallpaes/restaurant-list-crud
An awesome web application built with Node.js, Express, and MongoDB for you to readily manage your restaurant lists: Create, view, edit, delete, and search restaurant are as easy as pie 🥧
https://github.com/smallpaes/restaurant-list-crud
Last synced: 24 days ago
JSON representation
An awesome web application built with Node.js, Express, and MongoDB for you to readily manage your restaurant lists: Create, view, edit, delete, and search restaurant are as easy as pie 🥧
- Host: GitHub
- URL: https://github.com/smallpaes/restaurant-list-crud
- Owner: smallpaes
- Created: 2019-06-21T15:06:21.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2022-12-10T19:48:14.000Z (almost 2 years ago)
- Last Synced: 2023-03-03T02:21:23.117Z (over 1 year ago)
- Language: CSS
- Size: 1.56 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Restaurant List 🍣
An awesome web application built with Node.js, Express, and MongoDB for you to readily manage your restaurant lists: Create, view, edit, delete, and search restaurant are as easy as pie 🥧
## Project First Look
## Features
| Functions | Detail | URL |
| :--------------------: | ------------------------------------------------- | --------------------------- |
| View all restaurants | 1. User can view name, category, and rating of all restaurants
2. User can get an error message when no restaurant to display | / |
| View a restaurant detail | User can view restaurant name, category, address, description and image | /restaurants/:id |
| Create a restaurant | 1. User can add a new restaurant by inputting related info
2. User can get a placeholder image when image URL is not provided
3. User can get a warning message below corresponded column when submitting invalid info | /restaurants/new |
| Edit a restaurant | User can update detail info of a restaurant | /restaurants/:id/edit |
| Delete a restaurant | 1. User can delete a restaurant and receive warning message
2. User can receive a warning message before actual delete | /restaurants//:id/delete |
| Search restaurants by input | User can search restaurants by inputting name or category | /search |
| Search restaurants by rating | User can search restaurants by choosing a given rating | /search/rating/:rating |
| Search restaurants by category | User can search restaurants by choosing a given category | /search/category/:category |
| Page not found | User can get an error message when travelling to a page not existing | /:any_other_URL |
## 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 v10.16.0](https://nodejs.org/en/download/)
- [MongoDB v4.0.10](https://www.mongodb.com/download-center/community)
### Clone
Clone this repository to your local machine
```
$ git clone https://github.com/smallpaes/restaurant-list-CRUD.git
```
### Setup
1. Enter the project folder
```
$ cd restaurant-list-CRUD
```
2. Install npm packages
```
$ npm install
```
3. Import seed restaurants file
```
$ cd models/seeds
$ node restaurantSeeder.js
```
4. Find the message for successful import
```
> db connected!
> restaurant seeds are created
```
5. Activate the server
```
$ cd ../../
$ npm run dev
```
6. Find the message for successful activation
```
> Express is listening on http://localhost:3000
> mongodb connected!
```
You may visit the application on browser with the URL: http://localhost:3000
## Authors
[Mike Huang](https://github.com/smallpaes)