Caffeination FE

Rails Application

Find local coffee shops near you!

Table of Contents

• Author
• Getting Started
• Views
• Runing the tests
• Built With
• Versioning
• Acknowledgements

Author

• Kris Litman
  GitHub
  LinkedIn

Getting Started

API Keys

Before getting started with installation, you will need to create an account and get API keys from Yelp, Abstract for Geolocation Services, GoogleCloudPlatform, and OpenWeather Please sign up to get your own copy and include them as environment variables with Figaro. Run figaro install to add your own application.yml file to the application.

Installing

These instructions will get you up and running with a copy of the project on your local machine for development and testing purposes.

1. Fork and Clone this repo
2. Install gem packages: bundle install
3. Run rails db:{drop,create,migrate,seed} -- (you may see errors from pg_restore that you can ignore)
4. Run rails s to start the rails server
5. Run redis-server to start the redis server
6. Run bundle exec sidekiq -q default to start Sidekiq server
7. Run rails s -p 3001 on back-end repo to run the Rails API
8. Go to localhost:3000 to view the Development environment for the application!

Views

Home Page

localhost:3000/

Welcome to Caffeination! View local coffee shops near you, register a new account to star and remember your saved shops and share your favorite coffee shops. Enter a location to search for coffee shops, or click the button for current location to find your current zipcode.

Registration Page

localhost:3000/sign_up

Path to register a new user.

Log In Page

localhost:3000/log_in

Path to sign in an already registered user.

Log In with Google Oauth

localhost:3000/auth/:provider/callback

Route for initiating Oauth flow for Google with Omniauth.

Current Location

localhost:3000/current_location

Route for using geolocation services to find your current location.

Search Page

localhost:3000/search

After clicking on the search button, you will be brought to the Search page where you can see the coffee shop results for the location you input. Either filter the results by "No Starbucks", "Rating", or click on the next page of results.

Current Location

localhost:3000/coffee_shop

Route to show an individual coffee_shop from the search page.

Running the tests

Testing with RSpec To run the full test suite you will need to run the command: bundle exec rspec

To run individual tests use: bundle exec rspec spec/folder/file

Built With

• Rails
• PostgreSQL
• RSpec
• Capybara
• Launchy
• Factory Bot Rails
• Faker
• Fast JSON API
• HTTParty
• Shoulda Matchers
• Sidekiq
• Redis
• Bcrypt
• Better Errors
• Webmock
• VCR
• Pagy
• Omniauth
• Docker
• CircleCI
• Heroku

Versions

• Ruby 3.0.0

• Rails 6.1

Acknowledgements

• Yelp

• Abstract

• OpenWeather

• GoogleCloudPlatform