Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/smallpaes/restaurant-list-v3
An awesome web application built with Node.js, Express, and MongoDB for you to readily manage your restaurant lists with an account: Create, view, edit, delete, filter, sort, and search restaurant are as easy as pie 🥧
https://github.com/smallpaes/restaurant-list-v3
crud express-js facebook-login google-login mongodb mongoose nodejs passportjs restaurant restaurant-lists
Last synced: 2 months ago
JSON representation
An awesome web application built with Node.js, Express, and MongoDB for you to readily manage your restaurant lists with an account: Create, view, edit, delete, filter, sort, and search restaurant are as easy as pie 🥧
- Host: GitHub
- URL: https://github.com/smallpaes/restaurant-list-v3
- Owner: smallpaes
- Created: 2019-06-28T09:38:51.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2022-12-10T20:35:39.000Z (about 2 years ago)
- Last Synced: 2023-03-03T02:21:23.350Z (almost 2 years ago)
- Topics: crud, express-js, facebook-login, google-login, mongodb, mongoose, nodejs, passportjs, restaurant, restaurant-lists
- Language: CSS
- Size: 26.3 MB
- Stars: 5
- Watchers: 1
- Forks: 2
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Restaurant List v.3 🍣
An awesome web application built with Node.js, Express, and MongoDB for you to readily manage your restaurant lists with an account: Create, view, edit, delete, filter, sort, and search restaurant are as easy as pie 🥧
## Project First Look
## Features
| Functions | Detail | URL |
| :--------------------: | ------------------------------------------------- | --------------------------- |
| Sign up for an account | 1. User can sign up an account by inputting name, email, password
2. User can see warning message if required columns are empty or passwords inputted are incorrect
3. User can be redirected to login page and receive a warning message if the account inputted has been registered | /users/register |
| Log in with email | 1. User can log in using registered email | /users/login |
| Log in with Facebook account | User can log in via Facebook with a Facebook account | /auth/facebook |
| Log in with Google account | User can log in via Google with a Google account | /auth/google |
| Log out | User can log out of an account | /users/logout |
| View all restaurants | 1. User can view name, category, and rating of all restaurants after login
2. User can get an error message when no restaurant to display after login | / |
| View a restaurant detail | 1. User can view restaurant name, category, address, description and image after login
2. User can see his or her name on the logo, "食客" will be displayed if name is not provided | /restaurants/:id |
| Create a restaurant | 1. User can add a new restaurant by inputting related info after login
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 after login | /restaurants/:id/edit |
| Delete a restaurant | 1. User can delete a restaurant after login
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 after login | /search |
| Search restaurants by category | User can search restaurants by choosing a given category after login | /search |
| Pagination | User can see at most six restaurants on a page and travel among pages | /search |
| Filter restaurants | 1. User can filter restaurant list based on rating range after login
2. User can see the amount of restaurants at each rating range on filter panel based on given search input after login | /search|
| Sort all restaurants | User can sort restaurants list by name, rating, or category based on given search input after login | /search |
| 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-v3.git
```
### Setup
1. Create a new App at [https://developers.facebook.com/](https://developers.facebook.com/)
2. Create a new project at [https://console.developers.google.com/](https://console.developers.google.com/)
3. Enter the project folder
```
$ cd restaurant-list-v3
```
4. Install npm packages
```
$ npm install
```
5. Create .env file
```
$ touch .env
```
6. Store API Key in .env file and save
```
GOOGLE_ID=
GOOGLE_SECRET=
GOOGLE_CALLBACK=
FACEBOOK_ID=
FACEBOOK_SECRET=
FACEBOOK_CALLBACK=
```
7. Import user and restaurant seeds
```
$ cd models/seeds
$ node seeder.js
```
8. Find the message for successful import
```
> db connected!
> restaurant seeds are created
```
9. Activate the server
```
$ cd ../../
$ npm run dev
```
10. 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)