This is a reboot of the first project from the UNH Coding Bootcamp. I have been reorganizing and improving the javascript code from the original submission. The goal is to refactor into reusable methods and create maintainable code for future updates and/or expansion.
- Andrew H
- Bobby H
- Ryan F
- Kyle K
What is the mission statement of Pu ReVu? To help you find a Glorious and Clean public restroom experience without hassle!
It happens all too often. You're out on the town and nature calls. Home is too far, and you must make do with what's around. But you can never be sure what you might get when it comes to public facilities. That's where Pu ReVu comes in. Simply start the web app and hit "Let's Go!"
First thing, the Pu ReVu site will take account of your current location and load up a list of public restrooms in your area. Each one listed with an overall user recommendation and cleanliness rating. Click on a specific public restroom to get a full breakdown of all ratings along with any comments left by ReVuers™. This way you'll know what to avoid, and where to go.
But say you've found a discrepancy in a ReVu, or a restroom that lacks a rating. Now it's your chance to write your own Pu ReVu and become part of the ReVuers™ community. Simply list the business or location name, along with your zip code if not already documented by the site. Give a recommendation and cleanliness rating along with a personal comment. Hit the Submit button and you've done it! Now your ReVu is live and helping others.
Finally, you're ready to have a relaxing restroom experience. To help, Pu ReVu has provided a few reading materials to help pass the time. You can search the top trending New York Times articles by topic, try out the Dad Joke Generator, or check the local forecast.
It's easy, it's convenient, it's Pu Revu.
the toTitleCase() method returns a string with the first letter of each word capitalized.
Syntax
utils.toTitleCase(string)
the isZipCode() method tests the passed value if it's a string. returns a boolean. Valid zip codes can be formatted as 5 or 9 digits with the last 4 separated by a dash. Note 99999 does not exist as a US zip code, but the reqex expression that tests the passed value will still return true.
ex. 12345 or 12345-1234
Syntax
utils.isZipCode(string)
The getZipCodeFromWebStorage() method returns a zipcode from session storage. If webstorage is not supported, it returns undefined. Otherwise it will return the zip or null if there is no zip stored.
Syntax
utils.getSipcodeFromWebStorage()
The warningMessage() method appends an element with a warning message to the DOM.
Syntax
updateDom.warningMessage(string, string)
The first argument is the selector for the location to append the element on the dom. The second argument is the meassage you want to relay.
The submitSucess() method updates the DOM once a review has been successfully submitted.
Syntax
updateDom.submitSuccess()
the setZipFromSessionStorage() method will set the value of the zip code form field if there is a zip stored in session storage.
Syntax
updateDom.setZipFromSessionStorage()
The zip form field must have an id of display-zip
The renderListOfBusinesses() method appends a list of cards containing each businesses information
Syntax
updateDom.renderListOfBusinesses(object, method)
The first argument is the returned value from the firebase DB query. The second argument is utils.toTitleCase() used to capitalize the business name.
See firebase children for object structure
The renderFirstPuReviewer method appeds an element to the dom at a specified location.
Syntax
updateDom.renderFirstPuReviewer(string)
The only argument is a selector for the DOM element
The renderTotalRatings() method appends the total ratings of a business to a specified location in the DOM.
Syntax
updateDom.renderTotalRatings(string, object)
The first argument is an element selector. The second argument is an object with business info.
See firebase children for object structure
The listReviews() method apends a list of reviews at a specified location on the DOM.
Syntax
updateDom.renderTotalRatings(string, object)
The first argument is an element selector. The second is an object containing a business.
See firebase children for object structure
The listReviews() method appends a list of review cards to the DOM at a specified location.
Syntax
updateDom.listReviews(string, object)
The first argument is an element selector. The second is an object containing a business's reviews
All businessses and reviews are stored in the businesses child in the root of the databse.
Each business and review has a unique key identifier.
All new businesses and reivies should be 'pushed' into the db with the firebase reference push() method.
businesses: {
'some unique key': {
name: '',
zip: '',
ratings: {
clean: 0,
dirty: 0,
ok: 0,
oppose: 0,
recommend: 0
},{
reviews: {
'some unique key': {
comment: '',
dateAdded: '',
ratings: {
clean: 0,
dirty: 0,
ok: 0,
oppose: 0,
recommend: 0
},
}
}
}
}The Review() constructor has 3 properties. comment: string; ratings: object; dateAdded: string;
Syntax
fbController.Review(string, object, string)
The addNewBusiness() method pushes a new business into the businesses child in the db. It returns a promise and an object with a corresponing { businessKey } from the db push (if successful).
Syntax
fbController.addNewBusiness(object)
The one argument is an instance from the business constructor. Reviews should be empty as they need to be pushed into the db to generate unique keys.
The addNewReview() method pushes a new review into a corresponding business. It returns a promise with an object containing { reviewKey, businessKey } if successful.
Syntax
fbController.addNewReview(object, string)
The first argument is a review instance. The second is a string containing the reviews corresponding business key.
The updateBusinessRatings() method updates a businesses overall ratings from a users individual review.
Syntax
fbController.updateBusinessRatings(object, string)
The first argument is a review object, the second is a string containing the businessKey.
The findMatchingBusiness() method looks for a business with a matching name and zip in the db. If found, an object containing the business info will be returned. Else null will be returned.
Syntax
fbController.findMatchingBusiness(string, string)
The first argument is the business name. second is the zip code.
The getBusinessByZip() method returns all businesses with a given zip.
Syntax
fbController.getBusinessByZip(string)
The only argument is a string containing the zip code.
The getBusinessByKey() method returns an object with the business and its reviews as the 2 properties.
Syntax
fbController.getBusinessByKey(string)
The only argument is a string containing the child key from the db.
The pushNewReviewLogic() method submits a new review or business when a user submits their review.
It looks for a matching business to attach the review, If one doesn't exist, It will submit a new business, then submit the new review, then update the business's overall ratings.
Syntax
fbController.pushNewReviewLogic(string, string, object)
First argument is the business name, second is the zip code, third is the review object.