Coder Social home page Coder Social logo

animal_shelter's Introduction

Animal Shelter API

Week 6 Independent Project for Ruby at Epicodus

By Jessica Doss

Description

A an application that has animals for adoption at shelters. This is intended to demonstrate an understanding of building an API in Ruby and Rails.

Setup/Installation Requirements

  • Clone repository.
  • Enter project root directory and type "bundle install" to install all necessary gems.
  • Type "rake db:create" to create the databases.
  • Type "rake db:seed" to seed the products and reviews
  • Sign into Postman to test API calls

Endpoints

Behavior Route Input Output
GET animals localhost:3000/animals Returns list of all animals
GET animals ID localhost:3000/animals/{id} Returns the animal record with the given id
GET animals random localhost:3000/animals/random Returns the animal record with the given id
GET animals search localhost:3000/animals/search String required for term to search for
POST animals localhost:3000/animals Create a new animal record
Update animals localhost:3000/animals/{id} Allows shelter to make updates
DELETE animal localhost:3000/animals/{id} Deletes an animal record

Known Bugs

No known bugs

Support and contact details

Please contact us if you have any issues at: [email protected]

Technologies Used

  • Ruby
  • PostgreSQL
  • RubyGems
  • Atom
  • GitHub
  • Rails

Acknowledgements

Thank you to my teachers and partners this week. I wouldn't be where I am without you all.

License

This software is licensed under MIT license.

Copyright (c) 2019 Jessica Doss

animal_shelter's People

Contributors

pdxjess avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.