Shelter Me API

Epicodus Project in Ruby on Rails, December 15, 2017

By L. Devin MacKrell

Description

This is an API for a pet adoption site.

Installation and Setup

To install on your own machine, follow the instructions below:

• Clone this repository.
• Run the following commands in the project root directory:

  bundle update
  rake db:setup
  rails db:seed
  rails s
  

• Open localhost:3000 in your web browser

Specifications

• API provides the following information
  • Name
  • Breed
• API can accomodate the following:
  • GET (http://localhost:3000/api/v1/cats)
  • POST (http://localhost:3000/api/v1/cats)
  • PUT (http://localhost:3000/api/v1/cats/:id)
  • DELETE (http://localhost:3000/api/v1/cats/:id)
• API can provide a random cat: GET (http://localhost:3000/api/v1/cats/random)
• API can provide search parameters by specific breed
• API can support versioning
• API can handle exceptions
• API has thorough testing with request specs

Support and contact details

Please contact ldmackrell@gmail.com with questions, comments, or issues.

Technologies Used

• Ruby
• Rails
• Devise

License

Copyright (c) 2017 L. Devin MacKrell

This software is licensed under the MIT license.