Skip to content

Latest commit

 

History

History
53 lines (35 loc) · 2.83 KB

README.md

File metadata and controls

53 lines (35 loc) · 2.83 KB
Raw

uQueue - digital queuing application for small businesses

  • A submission to BeaverHacks Summer 2020 hackathon

  • Created by:

    • Andrew Jung : I worked on the front and backend for the customer and business management interface, and sending notifications to customers via sms and email. I used JavaScript, Node.js, Express.js, mongoDB, HTML, and CSS.
    • James Moseley : I did a lot of front end and styling. I worked with HTML, CSS, JQuery, and Bootstrap.
    • Hae-Ji Park : l worked on front and back end: login, logout, creating new user/business profile, authentication (by using jsonwebtoken), encrypting password(by using bcrypt). I worked with JavaScript, Node.js, Express, mongoDB, Bootstrap, HTML, CSS.

Inspiration

The current COVID-19 situation has created the need for social distancing. This has changed the way we as a society go about our everyday lives, one example in particular is the routine act of visiting your local businesses. In order to maintain safe distances occupancy limits are being enforced, and lines to enter businesses are becoming common. We built this app in hopes of addressing this issue

What it does

It gives small business the capability to allow their customers to form lines remotely to practice safe social distancing. Businesses just need to make an account and provide their customers with a "add customer portal" so they can join the line from the safety of their computer or mobile devices. Business have a portal where they can manage their customers, see the order of the line, and add and delete customers.

What's next for uQueue

We are going to keep working on our skills and maybe come back to this project. We will also be hosting this through Heroku as a public site.

How to Run

  1. Create new file named default.js in config folder.

** It includes private infos - related to database, etc, so it is not uploaded. Keep default.js private and please make sure not to upload or share with public. **

  1. In config/default.js,
module.exports = {
    mongoURI: 'your_mongoDB_URI_provided_by_mongoDB',
    jwtSecret: 'you_can_enter_anything',
    email: 'your_google_email_address_for_sending_notification',
    emailPW: 'your_google_email_password',
    accountSid: 'your_Account_SID_provided_by_Twilio',
    authToken: 'your_Auth_Token_provided_by_Twilio',
}
  1. In Terminal, (Make sure you're at beaverhacksSum20 folder)
npm i
npm start
  1. On your web browser, go to http://localhost:your_port_number/ and enjoy!

Built With

JavaScript / express.js / jquery / node.js / mongoDB / mongoose / html5 / css / bootstrap / cndjs / twilio