BarHawk is a mobile-friendly web application designed to track bar orders and Blood Alcohol Content (BACs). BarHawk allows customers to place orders with smart phones and displays all drink orders to bartenders in an organized manner. Customers are notified via text message when their drink is ready to be picked up. BAC’s are calculated for each customer every 5 minutes using a customer’s weight, gender, grams of alcohol consumed, and time elapsed since starting to drink. Customers can track their BAC over the course of a night while bartenders have access to a list of BAC’s for all customers. BarHawk reduces the chance of overserving and alleviates the stress of a crowded bar, making the experience easier and safer for customers and bartenders alike.
To get started, run these commands from the terminal:
$ git clone https://github.com/MKSBest/BarHawk.git
$ cd BarHawk
$ npm install
$ npm start
20 Mocha/Chai/Supertest server-side tests and 10 Jasmine/Karma client-side tests can be run by typing this command from the terminal:
$ npm test
Client Folder: Holds all files associated with the View, Controllers, and Factories. The client directory also contains the styling and assets.
ServerFolder: Contains the server, middleware, routing, database configuration, migration, and seeder files.
Specs: Contains 20 Mocha/Chai/Supertest server-side tests and 10 Jasmine/Karma client-side tests.
BarHawk
|-client
|---app # Configuration, views, controllers, and factories
|---assets # Logos and images
|---styles # Stylesheets and logos
|-server
|---database # Sequelize instantiation
|---migrations # PostgreSQL migrations
|---models # Schema
|---seeders # Database prepopulation
|-spec
|---client # Jasmine/Karma client-side controller tests
|---server # Mocha/Chai/Supertest server-side tests
Customers:
- Sort menu options by price, calories, carbs, sugar, and alcoholic content
- Order drinks and close bar tab via smart phone
- Visualize up-to-date BAC
- Track order history
Bartenders:
- Track customers' BACs
- Notify customers via text message that drink is ready to be picked up
- Notify customers of Last Call for drink orders half an hour before bar closes
- Hail taxis for customers in need
With more time, we would have loved to implement the below features. Feel free to check out our current issues.
- Enable customers to order more than one drink at a time
- Update BAC of one customer who received a drink purchased by a separate customer
- Upload customer photographs
- Solicit satisfaction ratings from customers and bartenders
- PayPal/credit card payment
- Move your drink order to the front of the queue by donating to Mothers Against Drunk Driving (MADD)
All code adheres to the style guide which is based on the airbnb style guide.
Thank you for taking interest in contributing! Please read our CONTRIBUTING.md and check out our current issues.