README.md

Bīk-n-Brü

This repo is the Front End portion of the Bīk-n-Brü project built by Mod 3 students at Turing School of Software and Design.

The purpose of this project is to encourage people to ride their bikes to bars to decrease their carbon footprint by gamifying the exercise/bar experience.

Visit our Bīk-n-Brü Website! Hosted on Heroku!

Also check out the Bīk-n-Brü Back End GitHub Repo

Table of Contents

• Learning Goals
• Planning Documents
• Tech & Tools Used
• How to Set Up
• How to Run Test Suite
• Use of Bīk-n-Brü
• Contributors

Learning Goals

• Continue to gain competency with Ruby on Rails Fundamentals
• Use Bootstrap to create a user-friendly experience
• Implementing OAuth log-in feature
• Consuming API's for user and activity information, to store in the back-end Application
• Planning and excecuting web application from idea to conception
• Testing asynchronous front-end API calls to OAuth provider and back-end application to external API's

Planning Documents

• Wireframes
• Project Spec

Tech and Tools

Gems Used:

• Pry
• Faraday
• Orderly
• Capybara
• Figaro
• Webmock
• VCR
• Launchy
• RSpec
• Simple-Cov
• Factory Bot for Rails
• Faker
• Shoulda Matchers
• Bootstrap

Built With

• 2.7.4
• 5.2.8.1
• 3.12.0
• 
• 
• 

Developer Setup

1. Fork and clone this repository
2. cd into the root directory
3. Run bundle install
4. Run bundle exec figaro install
5. Run rails db:{create,migrate}
6. To run this server, run rails s in your terminal
7. To stop the local server, use command Control + c

8. Sign up to use the Strava API

   In config > application.yml

      strava_client_id: <client_id>
      strava_client_secret: <client_secret>
   

How to Run Test Suite

After set up:

1. Run bundle exec rspec spec

Use of Bīk-n-Brü

• The landing page is home base. You will see a current user leaderboard with stats about that user and login options:
  

• If you do not currently have a Strava account, choose that option. You will be directed to the Strava website and asked to set up an account.

• Once you have signed up for a Strava account, return to the landing page to sign in using Strava OAuth.

• You will use OAuth through your Strava account to utilize the Bīk-n-Brü site.
  

• Once you are logged in using the Strava OAuth, you will be redirected to your dashboard page.
  

• From your landing page you have access to many features, including:

  • Creating an Activity: To create a new activity you would use you choose the brewery that you went to, your beverage of choice and click the button to "Tell me how many beers I've earned".

  • You would then be taken to that Activities show page.
    

  • The index of breweries around your location: click on the "View All Local Breweries" link and you will be taken to the breweries index page.
    

• The navigation bar appears on all pages, allowing you to return to your home page, dashboard or logout at any time.

Project Team:

Contributors

Amanda Ross	Yuji Kosakowski	Rich Kaht	Gabe Nuñez	Annie Pulzone
GitHub LinkedIn	GitHub LinkedIn	GitHub	GitHub LinkedIn	GitHub LinkedIn

Project Manager:

Mike Dao

GitHub LinkedIn