ping8601 / restaurant-list

A restaurant list website built with Node.js and Express

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

restaurant-list

A restaurant list website built with Node.js and Express. It allows the users to create their own acocunts and manage their favorite restaurants.

Features

  • Users can register with their name, email, and password
  • Users can also choose to register and login with Facebook or Google accounts
  • User can create a new restaurant
  • Users can view the detail information of the restaurants by clicking on the cards
  • Users can edit the detail of the restaurants
  • Users can search for the restaurants with keywords
  • Users can delete the restaurants

Website Screenshot

  • Register image
  • Login image
  • Home page image
  • Detail page image
  • Create new restaurant image
  • Edit restaurant image

Getting Started

Environment

  • Node.js 16.17.0
  • npm 8.15.0
  • MongoDB

Installation

  1. Open the Terminal and clone the repo
git clone https://github.com/ping8601/restaurant-list/
  1. Use the Terminal to open the folder of the project
cd restaurant-list
  1. Install all the needed package with npm
npm install
  1. Add a file .env and add required environment variables mentioned in .env.example

  2. Add the seed restaurant and seed users

npm run seed
  1. Start the server
npm run start
  1. If you see this message, the server is successfully started
Express is now listening on localhost:3000
  1. Open your brower and enter the link http://localhost:3000 to start exploring the website!

  2. Use two test accounts in the seed data to login or create your own acocunt.

email: user1@example.com
password: 12345678
--------------------------
email: user2@example.com
password: 12345678
  1. Press control + c to end the server

Development Tools

  • Bcryptjs 2.4.3
  • Bootstrap 4.3.1
  • Connect-Flash 0.1.1
  • Dotenv 8.2.0
  • Node.js 16.7.0
  • Express 4.16.4
  • Express-Handlebars 3.0.0
  • Express-Session 1.17.1
  • Font-awesome 5.8.1
  • Method-Override 3.0.0
  • Mongoose 5.9.7

About

A restaurant list website built with Node.js and Express


Languages

Language:Handlebars 53.7%Language:JavaScript 41.2%Language:CSS 4.4%Language:Shell 0.7%