Skip to content

Latest commit

 

History

History
154 lines (117 loc) · 4.74 KB

README.md

File metadata and controls

154 lines (117 loc) · 4.74 KB

Aura-Bar-Liquor-Review-System

This is CS546 Project Repo


Table of Contents
  1. Members
  2. About The Project
  3. Getting Started
  4. Database
  5. Contact
  6. Reference

Members

Zimeng Zhao
Xin Jin

(back to top)

About The Project

Welcome to our Aura Bar Management app, specifically crafted for those passionate about bars and liquor. Our platform responds to the growing need for detailed information about drink quality, service, pricing, and ambiance. It features a user-friendly interface, offering comprehensive reviews and ratings to assist in finding the best liquor options. Key functionalities include a versatile login interface, a vivid liquor display page, in-depth liquor details with user reviews, a personalized user profile, and a robust bar management section for administrators. Enhance your liquor discovery experience with added features like photo-inclusive reviews, online reservations, and an easy-to-use contact menu.

(back to top)

Built With

To develop this project, you will need the following tools:

  • JavaScript
  • Express.js
  • node.js
  • postman
  • mongodb
  • handlebars

(back to top)

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

How to start the project:

  1. Install MongoDB & node.js.

  2. make sure the creation of Database name aura_bar_liquor_system and collections name of users, reviews and users

  3. Make sure the following ports are not occupied: 27017(MongoDB service), 3000.

  4. Open your terminal, enter the command below, and choose a folder in which to clone the repository.

    git clone https://github.com/XinJin96/Aura-Bar-Liquor-Review-System.git
  5. Go to the project root directory and run below code in terminal to install NPM packages

      npm i
  6. Run Seed.js file to load all testing data

  7. Add Enviroment Variable

    accountSid

    with value

    *****

    and

    authToken

    with value

    *****
  8. Run below code in terminal to start the program

      npm start

    Then, you can open http://localhost:3000 on browser, enjoy!

(back to top)

Reference

(back to top)