https://github.com/j-obog/state-boundries
RESTful API written in Go for finding out which states border which.
https://github.com/j-obog/state-boundries
geography go golang heroku-deployment rest-api
Last synced: 5 months ago
JSON representation
RESTful API written in Go for finding out which states border which.
- Host: GitHub
- URL: https://github.com/j-obog/state-boundries
- Owner: J-Obog
- License: mit
- Created: 2021-10-12T01:00:08.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2021-10-26T13:21:51.000Z (over 4 years ago)
- Last Synced: 2024-06-20T06:24:43.240Z (about 2 years ago)
- Topics: geography, go, golang, heroku-deployment, rest-api
- Language: Go
- Homepage: https://state-boundries.herokuapp.com/api/borders/
- Size: 16.6 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# State Boundries
RESTful API written in Go for finding out which states border which.
Utilizes the [gorilla/mux](https://pkg.go.dev/github.com/gorilla/mux) package for routing and a few built-in Go packages.
## Live Server
This project has been deployed on Heroku. If you use visit [https://state-boundries.herokuapp.com/api/borders/](https://state-boundries.herokuapp.com/api/borders/), it will `GET` the list of all 50 states and the states that they share a border with.
## Installation & Testing locally
Make sure that you have the latest version of [Go](https://golang.org/dl/) installed on your machine.
You can clone this repository, install the requisite dependencies and run it on your machine like so:
```
$ git clone https://github.com/J-Obog/state-boundries.git
$ cd state-boundries
$ go install
$ go run .
```
## Endpoints
`GET` **/api/borders/:state** - *Get the a specific state and the states that border it*
`GET` **/api/borders/** - *Get all states and their borders*