This API was built in conjunction with the home_me_fe Front 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 BackEnd team for the app, we are exposing API endpoints to be consumed by the FrontEnd team to be displayed to the user.
Versions
Ruby Version - 2.7.4
Rails - 5.2.7
Setup
Clone this repo
bundle install
bundle exec figaro install
rails db:{create,migrate,seed}
Get Google API key here and place in config/application.yml file
run bundle exec rspec to run our RSpec testing suite
execute the Postman collection below to test the endpoints
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!
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent