A Comic Trivia Challenge (2 week sprint)

Chaz Simons, Sam Devine, Matthew Kimball, Ted Staros & Christian Valesares

Have you bragged about your comic knowledge in the past?? Put those claims to the test with this exciting quiz app!

"Bragging Rights" is a trivia competition app that lets you flex that knowledge! Find out how you rank against users from your city, state or country! Users log in with Twitter, and can tweet their scores to challenge friends.

Here's some gifs demoing our functionality:

Twitter Signin ** Signing in with Twitter is fast, easy, and secure! **

User Dashboard ** Your dashboard has your highest scores, and a place to tweet a challenge to your friends! **

Answering Questions ** Choose the right answer, but don't take too long! Time is a factor in your score. **

Final Score ** When you've finish the game, go ahead and get your brag on. We won't tell anyone. **

Leaderboard ** Find out how you stack up against people in your city, state, country, or world wide from the high scores page! **

Take the quiz at Bragging Rights!

Tech Stack:

• Rails 5.2.6
• Ruby 2.7.2
• PostgreSQL
• Heroku
• Twitter OAuth v1.0a

Setup

If you'd like to fork the repository and pull it down to explore locally, you'll need to follow along with our setup guide below:

• From the command line, install gems and set up your DB:
  • bundle
  • rails db:{create,migrate}
• Sign up for a Twitter Developer account (if you don't already have one), create an app, and grab your API Key and Secret.
  • Under user authentication settings, make sure to enable OAuth 1.0, ask users for Read and Write permissions, and use http://localhost:3000/auth/twitter/callback (or your preferred port) for the callback URL, and https://shielded-anchorage-65791.herokuapp.com/ for the site url.
• Back on the command line, run bundle exec figaro install to create an application.yml file and add it to your .gitignore (for keeping your API keys secret and safe).
• Add the following lines to your application.yml file, replaying {key} and {secret} with the information from your Twitter developer portal:

  twitter_api_key: {key}
  twitter_api_key_secret: {secret}
  

• Run the test suite with bundle exec rspec.
• Run your development server with rails s, and navigate to localhost:3000 in your browser to see the app in action.

Architecture

This app is created with a service oriented architecture. This front-end component sends and receives api calls from our backend to populate questions and record user scores. The api calls are consumed with a service-facade design pattern to lessen the the amount of data stored and improve performance. Twitter login is handled by the OmniAuth-Twitter gem.

The following pages are built for the platform:

• Login
• User Dashboard
• Trivia Questions
• Leaderboard

APIs

Open Trivia Database This API was utilized to populate our quiz with comic themed questions.

IP API Finds a user based on IP address. This allows us to store their location and compare results against other users.

Twitter API Used in conjunction with OmniAuth-Twitter to allow users to draft tweets about their high scores.