Skip to content

jjdelacruz1/Phase1Project

Repository files navigation

alt text

Build Status JavaScript Style Guide JavaScript Style Guide

Project Information

Simple web application called Happy Hour Finder. The premise of the web app is to help users find local happy hours by searching with either their zip code or city. Here is the link to our site: http://happyhourfinder.surge.sh

Goals

  • Integrate two remote APIs using AJAX
  • Use another JS library that is not jQuery
  • Deploy our project elsewhere besides Github pages
  • Learn how to break code into different files or modules

Features

  • Search for happy hours by city or zip
  • Browse through top happy hour results
  • Swipe through interactive map that marks the location for each result
  • Click results to learn more about the business via Yelp
  • Find the easter egg! May be easier if you're under 21 😉

Languages Used

  • HTML
  • CSS
  • JavaScript

Technologies Used

Name Description
jQuery Simplifies DOM tree traversal and manipulation, event handling, CSS animation, and AJAX
Bootstrap Framework for typography, forms, buttons, navigation and other interface components
Mapbox Extensible mapping platform for customizable maps, location search and live location data
Yelp Fusion Utilize Yelp's database of business data, content and information
Travis CI Sync Github projects to continually test and deploy projects
Bideo Responsive background video
Random Chuck Norris Generate random Chuck Norris jokes

Available Scripts

In the project directory, you can run:

Install Node Modules folder

npm install

Development Process

  1. Brainstorm app concept
  2. Research APIs needed to achieve project objectives: acccess a database of bars searchable by location and mapping custom location markers
  3. Read API documentation for Mapbox, Yelp, and Chuck Norris
  4. Read library documentation for Bideo, Bootstrap and jQuery
  5. Breakdown of objectives into smaller, simpler tasks
  6. Division of code resposiblities to team members
  7. Daily scrum meetings to discuss progress and next steps
  8. Debug and testing on desktop and mobile

Challenges Encountered

Most of the challenges we encountered pertained to the app's search feature such as:

  • Saving the user's search term on one page and rendering the results on another
  • Looking into why the search wasn't working on the results page, while it works fine on the homepage
  • Assign the submit button to the user's enter key
  • Hard code 'happy hour' parameter

Customizing the Mapbox API required heavy research for implementation:

  • Returning to cleared state for map markers
  • Removing default behaviors like zooming on scroll
  • Map markers reactive to mouse hovers

and the Yelp Fusion API had its fair share of problems:

  • Ignoring undefined values from JSON data
  • Offseting results to apply next/previous page
  • Pinpointing which business values we need to render

Key Takeaways

  • Integrating APIs that require authentication
  • Commit often and pull always
  • Don't be afraid to refactor code!
  • Modularize functions
  • Trello is your friend
  • Merge conflicts are not that scary
  • As this was our first project, this app was optimized for the "happy trail" user

Team Members

About

Happy Hour Finder for your area! Get the best experience with us!

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 3

  •  
  •  
  •