{"id":19536370,"url":"https://github.com/hoangphidev/vietnam-maps","last_synced_at":"2025-04-26T14:36:35.314Z","repository":{"id":54307851,"uuid":"314971991","full_name":"hoangphidev/vietnam-maps","owner":"hoangphidev","description":"🚀 Laravel database of Vietnam's area.","archived":false,"fork":false,"pushed_at":"2023-12-20T07:36:24.000Z","size":683,"stargazers_count":13,"open_issues_count":0,"forks_count":15,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-09-22T22:17:54.635Z","etag":null,"topics":["database","general-statistics-office","laravel-package","php","vietnam","vietnam-area","vietnam-database","vietnam-maps"],"latest_commit_sha":null,"homepage":"","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/hoangphidev.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-11-22T06:10:24.000Z","updated_at":"2023-07-29T08:34:44.000Z","dependencies_parsed_at":"2023-02-01T05:55:17.303Z","dependency_job_id":null,"html_url":"https://github.com/hoangphidev/vietnam-maps","commit_stats":null,"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hoangphidev%2Fvietnam-maps","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hoangphidev%2Fvietnam-maps/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hoangphidev%2Fvietnam-maps/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hoangphidev%2Fvietnam-maps/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/hoangphidev","download_url":"https://codeload.github.com/hoangphidev/vietnam-maps/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":224037124,"owners_count":17245173,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["database","general-statistics-office","laravel-package","php","vietnam","vietnam-area","vietnam-database","vietnam-maps"],"created_at":"2024-11-11T02:22:33.730Z","updated_at":"2024-11-11T02:22:35.381Z","avatar_url":"https://github.com/hoangphidev.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"## Vietnam Maps\n\nDatabase of Vietnam's area.\n\nData are taken directly from the General Statistics Office of Vietnam.\n\n[![Latest Version on Packagist](https://img.shields.io/packagist/v/hoangphi/vietnam-maps.svg?style=flat-square)](https://packagist.org/packages/hoangphi/vietnam-maps)\n[![Total Downloads](https://img.shields.io/packagist/dt/hoangphi/vietnam-maps.svg?style=flat-square)](https://packagist.org/packages/hoangphi/vietnam-maps)\n\n## Install\n\n```shell\ncomposer require hoangphi/vietnam-maps\n```\n\n## Extracting\n\n### Method 1:\n\nExtract directly via command: \n\n```shell\nphp artisan vietnam-map:install\n```\n\n### Method 2:\n\n#### Copy file config và migration\n\n```shell\nphp artisan vendor:publish --provider=\"HoangPhi\\VietnamMap\\VietnamMapServiceProvider\"\n```\n\n#### Customize config và migration\n\n1. Rename table\n\nOpen file `config/vietnam-maps.php` and config:\n\n```php\n'tables' =\u003e [\n    'provinces' =\u003e 'provinces',\n    'districts' =\u003e 'districts',\n    'wards'     =\u003e 'wards',\n],\n```\n\n2. Rename column\n\nOpen file `config/vietnam-maps.php` and config:\n\n```php\n'columns' =\u003e [\n    'name'        =\u003e 'name',\n    'gso_id'      =\u003e 'gso_id',\n    'province_id' =\u003e 'province_id',\n    'district_id' =\u003e 'district_id',\n],\n```\n\n3. Add column\n\nOpen the following migration files and customize if you need:\n\n```shell\ndatabase/migrations/{datetime}_create_vietnam_maps_table.php\n```\n\n#### Run migration\n\n```shell\nphp artisan migrate\n```\n\n#### Download và import into database\n\n```shell\nphp artisan vietnam-map:download\n```\n\n## Usage with Models\n\n1. Get all provinces, districts, wards\n\n```php\n    use HoangPhi\\VietnamMap\\Models\\Province;\n    use HoangPhi\\VietnamMap\\Models\\District;\n    use HoangPhi\\VietnamMap\\Models\\Ward;\n\n   class DevController extends Controller\n   {\n       ...\n       public function dev()\n       {\n           $provinces = Province::all();\n           $districts = District::all();\n           $wards = Ward::all();\n           ...\n       }\n   }\n```\n\n2. Get data using relationship\n\n```php\n    use HoangPhi\\VietnamMap\\Models\\Province;\n\n   class DevController extends Controller\n   {\n       ...\n       public function dev()\n       {\n           $province = Province::first();\n           $districts = $province-\u003edistricts;\n           ...\n       }\n   }\n```\n3. Relation in Province.php\n\n```php\n    class Province extends Model\n    {\n        ...\n        public function districts()\n        {\n            return $this-\u003ehasMany(District::class);\n        }\n    }\n```\n\n4. Relation in District.php\n\n```php\n    class District extends Model\n    {\n        ...\n        public function province()\n        {\n            return $this-\u003ebelongsTo(Province::class, config('vietnam-maps.columns.province_id'), 'id');\n        }\n        \n        public function wards()\n        {\n            return $this-\u003ehasMany(Ward::class);\n        }\n    }\n```\n\n5. Relation in Ward.php\n\n```php\n    class Ward extends Model\n    {\n        ...\n        public function district()\n        {\n            return $this-\u003ebelongsTo(District::class, config('vietnam-maps.columns.district_id'), 'id');\n        }\n    }\n```\n\n## Changelog\n\nPlease see [CHANGELOG](CHANGELOG.md) for more information what has changed recently.\n\n## Security\n\nIf you discover any security-related issues, please email [hoangphidev@gmail.com](mailto:hoangphidev@gmail.com) instead of using the issue tracker.\n\n## Credits\n\n- [Phi Hoang](https://github.com/hoangphidev)\n- [All Contributors](../../contributors)\n\n## References\n\n1. [General Statistics Office of Vietnam](https://www.gso.gov.vn/dmhc2015)\n2. [Vietnam Zone](https://github.com/kjmtrue/vietnam-zone)\n\n## License\n\nThe Laravel framework is open-sourced software licensed under the [MIT license](https://opensource.org/licenses/MIT).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhoangphidev%2Fvietnam-maps","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhoangphidev%2Fvietnam-maps","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhoangphidev%2Fvietnam-maps/lists"}