Ethan-t-n / The_Throne_Room_api

About This Project:

The Throne Room provides users with the ability to review public restrooms in their area

The Throne Room is an application that utilizes a frontend and backend application together they store bathroom locations and reviews displaying them on a map. This backend is responsible for receiving requests from the frontend and converting addresses and ip-addresses to lattitude and longitude.

Table of Contents

• Local Setup
• Deployment
• Endpoints
• Schema
• Authors

Local Setup:

This project requires:

• Ruby 2.7.4
• Rails 5.2.8

• Fork this repository
• Clone your fork
• From the command line, install gems and set up your DB:
  • bundle install
  • rails db:create
  • rails db:migrate

Throne-Room-Back-End utilizes the following gems and libraries in testing:

• RSpec
• ShouldaMatchers
• Capybara
• SimpleCov
• vcr
• webmock
• faker
• factory_bot

Deployment

Throne-Room-api is deployed remotely via Heroku (https://the-throne-room-api.herokuapp.com/)

Endpoints:

Throne Rooms

• get '/throne_rooms'
• get '/throne_rooms/:id'
• post '/throne_rooms'
• patch '/throne_rooms/:id'
• delete '/throne_rooms/:id'
• get '/throne_rooms/closest_five'
• get '/throne_rooms/last_five'

Reviews

• get '/throne_rooms/:id/reviews'
• get '/throne_rooms/:throne_id/reviews/:id'
• post '/throne_rooms/:id/reviews'
• patch '/throne_rooms/:throne_id/reviews/:id'
• delete '/throne_rooms/:throne_id/reviews/:id'
• get '/throne_rooms/:id/reviews/recent'

Schema

Authors

• Michael Bonini - Turing Student - GitHub Profile - LinkedIn
• Thomas Turner - Turing Student - GitHub Profile - LinkedIn
• Ethan Nguyen - Turing Student - GitHub Profile - LinkedIn
• Ben Silverstein - Turing Student - GitHub Profile - LinkedIn
• Gauri Joshi - Turing Student - GitHub Profile - LinkedIn
• Mary Turpin - Turing Student - GitHub Profile - LinkedIn