https://github.com/tenshiamd/phil_locator

Provides registry records for regions, cities, provinces and barangays in the Philippines.
https://github.com/tenshiamd/phil_locator

gem

Last synced: 2 months ago
JSON representation

Provides registry records for regions, cities, provinces and barangays in the Philippines.

• Host: GitHub
• URL: https://github.com/tenshiamd/phil_locator
• Owner: tenshiAMD
• License: mit
• Created: 2019-10-17T04:48:22.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2024-08-23T08:16:51.000Z (4 months ago)
• Last Synced: 2024-09-23T09:45:46.939Z (3 months ago)
• Topics: gem
• Language: Ruby
• Homepage: https://rubygems.org/gems/phil_locator
• Size: 1.61 MB
• Stars: 2
• Watchers: 2
• Forks: 1
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Phil Locator

[![Gem Version](https://badge.fury.io/rb/phil_locator.svg)](https://badge.fury.io/rb/phil_locator)

[![Known Vulnerabilities](https://snyk.io/test/github/tenshiAMD/phil_locator/badge.svg?targetFile=Gemfile.lock)](https://snyk.io/test/github/tenshiAMD/phil_locator?targetFile=Gemfile.lock)

[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2FtenshiAMD%2Fphil_locator.svg?type=shield&issueType=license)](https://app.fossa.com/projects/git%2Bgithub.com%2FtenshiAMD%2Fphil_locator?ref=badge_shield&issueType=license)

## Description

Provides registry records in the Philippines which the data came from PSA (PSGC).

- `regions`

- `cities` 

- `provinces`

- `barangays`

- `island_group`

- `municipality`

- `districts` (Metro Manila Only)

- `sub_municipality` (Metro Manila Only)

## Installation

In Gemfile:

```

gem "phil_locator", "~> 1.3.0"

```

Or, from the command line:

```

gem install phil_locator -v "~> 1.3.0"

```

    

## Usage

```

# Regions

PhilLocator::Region.all

# Provinces

PhilLocator::Province.all

# Cities

PhilLocator::City.all

# Barangays

PhilLocator::Barangay.all

```

## Configuration

Create an initializer `phil_locator.rb` to configure the options, here's a sample provided below

```

PhilLocator.configure do |config|

    # This overrides the default data directory

    config.data_root_path = Rails.root.join("datasets").to_s

end

```

## Copyright

This project is released under the [MIT license](/LICENSE).

## License

[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2FtenshiAMD%2Fphil_locator.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2FtenshiAMD%2Fphil_locator?ref=badge_large)