Go Location ▲

Introduction 🖖

This Package offers a simple way to get Countries, Cities and States that you may need for your Application, most especially for location dropdown.

Getting Started 💽

Install Package

Install this Package by running:

go get github.com/ichtrojan/go-location

Import Package

import "github.com/ichtrojan/go-location"

Usage 🧨

This package will return the output in structs, you can manipulate the output however you choose. You can check the main.go file located in the example directory, the sample code in there returns the output as JSON to the web.

Demo

Clone this repo: git clone github.com/ichtrojan/go-location
Change directory to example folder: cd go-location/example
Run the application: go run main.go
Visit application:

Endpoint	Description
`/country`	return all countries
`/country/{id}`	return a single country by its ID
`/state`	return all states
`/state/{id}`	return a single state by its ID
`/states/{countryID}`	return all states in a country using the country ID
`/city`	return all cities
`/city/{id}`	return a single city by its ID
`/cities`	return all cities in a state using the state ID

Package Methods

Get all countries

golocation.AllCountries()

Get a Country

golocation.GetCountry(id)

NOTE
id refers to the country ID

Get all states

golocation.AllStates()

Get a state

golocation.GetState(id)

NOTE
id refers to the state ID

Get all states in a country

golocation.GetCountryStates(id)