HomeMe

Welcome to the HomeMe Application!

• This application was built in conjunction with the home_me_be Back End application.
• This application is designed to provide a way for people who need shelter to find homeless shelters and directions to them.
• At this time, the app utilizes available shelter API in the Washington DC area with the idea that one day it can implement more shelter APIs from across the country as they become available.
• We consume the external APIs of Google Maps and DC Shelters to gather data about homeless shelters in the Washington DC area as well as directions to those shelters from a given starting point.
• As the FrontEnd team for the app, we are consuming API endpoints to be exposed by the BackEnd team to be displayed to the user.

Versions

• Ruby Version - 2.7.4
• Rails - 5.2.7

Setup

• Clone this repo
• bundle install
• rails db:{create,migrate,seed}
• run bundle exec rspec to run our RSpec testing suite
• execute the Postman collection below to test the backend endpoints

BackEnd Available Endpoints - Postman Collection

• Click this link
• Copy the entire text
• Open Postman, select "Import" from top left of page, then "Raw text" from the top line
• Paste the entire text
• Click "Continue", then "Import"
• Check out the endpoint examples - we have calls to the external APIs consumed by our app, as well as demonstrations of the responses returned from our own API endpoints!

Front End Schema

Back End Schema

Contributors

Back End Team

• Andrew Speth GitHub, LinkedIn
• Michael Hicks GitHub, LinkedIn
• Scott Sullivan GitHub, LinkedIn

Front End Team

• Ian Ross GitHub, LinkedIn
• Craig Cardwell GitHub, LinkedIn
• Chris Romero GitHub, LinkedIn