https://github.com/shibuyakosuke/laravel-postalcode-japan
郵便番号データを取り込んで住所マスタを作成します。
https://github.com/shibuyakosuke/laravel-postalcode-japan
cities laravel laravel-package migration prefecture
Last synced: about 1 year ago
JSON representation
郵便番号データを取り込んで住所マスタを作成します。
- Host: GitHub
- URL: https://github.com/shibuyakosuke/laravel-postalcode-japan
- Owner: ShibuyaKosuke
- Created: 2019-11-11T09:44:34.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-12-14T07:58:25.000Z (over 2 years ago)
- Last Synced: 2024-09-15T14:04:33.571Z (almost 2 years ago)
- Topics: cities, laravel, laravel-package, migration, prefecture
- Language: PHP
- Homepage:
- Size: 40 KB
- Stars: 10
- Watchers: 2
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# laravel-postalcode-japan
[郵便番号データ](https://www.post.japanpost.jp/zipcode/dl/kogaki/zip/ken_all.zip)を取り込んで住所マスタを作成します。
## Install
```
composer require shibuyakosuke/laravel-postalcode-japan
```
## Setup
マイグレーションを実行します。
```
php artisan migrate
```
postal_codes, cities, prefectures テーブルが作成されます。
```
php artisan postalcode:update
```
を実行すると、自動的に[郵便番号データ](https://www.post.japanpost.jp/zipcode/dl/kogaki/zip/ken_all.zip)をダウンロードし、
各テーブルにデータを投入します。同じコマンドを再度実行しても、cities, prefectures のデータは updateOrCreate() で更新されます。
また、テスト環境などで全都道府県のデータまでは不要な場合、`--test` オプションをつけて実行することで、東京都のデータのみを投入することもできます。
## Usage
あらかじめルートが設定されており、`ajax/prefectures/` にアクセスすると都道府県の一覧、`ajax/cities/{prefecture}`
にアクセスすると市区町村の一覧をJSONデータで取得することができます。