Caffeination

Rails API Application

Find local coffee shops near you!
Heroku Link

Table of Contents

• Author
• Getting Started
• Endpoints
• 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 an API key from Yelp 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. Enter endpoints (see below) into Postman to see JSON responses!

Endpoints

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
• Postman
• RSpec
• Capybara
• JSON API Serializer
• HTTParty
• Shoulda Matchers
• Factory Bot Rails
• Better Errors

Versions

• Ruby 3.0.0

• Rails 6.1

Acknowledgements

• Yelp