This is a Rails app exposing an API endpoint fetching the shortest route through an ordered list of addresses.
Foundation was set up using this as a guide.
Returns a JSON object with geolocations array, which is the geolocations of the addresses in the order you provided them to the API, and an order array giving the order in which these addresses should be visited (as array indices), which is the shortest route through them.
-
URL
/shortest-route
-
Method:
GET -
URL Params
Required:
addresses=[string_array]Each item in the array is separated by a
|(pipe), likeSeattle,WA|Portland,OR|Los%20Angeles,CA|Denver,CO|Des%20Moines,IA. -
Success Response:
- Code: 200
Content:{"geolocations":[{"latitude":47.6038321,"longitude":-122.3300624},{"latitude":45.5202471,"longitude":-122.6741949},{"latitude":34.0536909,"longitude":-118.2427666},{"latitude":39.7392364,"longitude":-104.9848623},{"latitude":41.5910641,"longitude":-93.6037149}],"order":[0,4,3,2,1]}
- Code: 200
-
Error Response:
TODO
You'll need docker and docker-compose installed. Get the app built up and running on your machine with
docker-compose upYou should always run rails commands, gem installs on top of Docker.
docker-compose run web railsIf you install some packages with bundler, you'll want to rebuild with
docker-compose run web bundle install && docker-compose up --buildIf you run into this error booting up the server:
standard_init_linux.go:211: exec user process caused "no such file or directory"Docker runs into issues with Dockerfiles with CRLF line endings on Windows. Before you clone this repo, force git to not change the line endings with:
git config --global core.autocrlf falseThen you should be able to clone the repo and boot up the server.
Using rails commands to generate stuff on Linux using Docker assigns the new files root permissions. Fix this by running this snippet from the root of the app before you start working on those files:
sudo chown -R $USER:$USER .We use Heroku to host the production release. It's at communitytech-tsp.herokuapp.com.
Docker images for the app are deployed to run on Heroku, not by using a traditional git push.
Make sure you're logged in to Heroku's container registry. If you logged in already, you can skip this step.
heroku container:loginBuild the image for the app, and push it to the container registry.
heroku container:push webRelease the image for the app.
heroku container:release webVisit the app on Heroku to make sure everything is working.
heroku openOne-liner for building and releasing.
heroku container:push web && heroku container:release web