Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dipesh79/laravel-nepal-address-seeder
Laravel Nepal Address Seeder - Get Migration And Seeder For Nepal's Province, Districts And Local Levels
https://github.com/dipesh79/laravel-nepal-address-seeder
Last synced: 2 days ago
JSON representation
Laravel Nepal Address Seeder - Get Migration And Seeder For Nepal's Province, Districts And Local Levels
- Host: GitHub
- URL: https://github.com/dipesh79/laravel-nepal-address-seeder
- Owner: Dipesh79
- License: mit
- Created: 2024-04-19T10:29:04.000Z (7 months ago)
- Default Branch: master
- Last Pushed: 2024-09-16T10:26:42.000Z (about 2 months ago)
- Last Synced: 2024-11-01T15:33:18.434Z (6 days ago)
- Language: PHP
- Size: 38.1 KB
- Stars: 1
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Laravel Nepal Address Seeder
[](https://packagist.org/packages/dipesh79/laravel-user-logs)
[](https://packagist.org/packages/dipesh79/laravel-user-logs)
[](https://packagist.org/packages/dipesh79/laravel-user-logs)
This Laravel package allows you to add Province, District and Local Levels of Nepal.
## Usage/Examples
### Install Using Composer
```bash
composer require dipesh79/laravel-nepal-address-seeder
```
### Publish Vendor File For Migration And Configuration File
```bash
php artisan vendor:publish
```
And publish `Dipesh79\LaravelNepalAddressSeeder\NepalAddressServiceProvider`
### Run Migration
```bash
php artisan migrate
```
## Config File
Set the configuration in the `nepal_address_seeder.php` file in the config directory.
```php
'\Dipesh79\LaravelNepalAddressSeeder\src\Models\Province',
/**
* Province Name in the database.
*
* This is the column name in the database where the province name will be stored.
*/
'province_name' => 'name',
/**
* Opt in if you want to add capital in the database.
*
* This will add the capital of the province in the database.
*/
'add_province_capital' => false,
/**
* Province Capital in the database.
*
* This is the column name in the database where the province capital will be stored.
*/
'province_capital' => 'capital',
/**
* Opt in if you want to add no of districts in the database.
*
* This will add the no of districts in the province in the database.
*/
'add_province_no_of_districts' => false,
/**
* Province No Of District in the database.
*
* This is the column name in the database where the province no of districts will be stored.
*/
'province_no_of_districts' => 'no_of_districts',
/**
* District Model.
*
* This is the model that will be used to seed the districts.
*/
'district' => '\Dipesh79\LaravelNepalAddressSeeder\src\Models\District',
/**
* District Name in the database.
*
* This is the column name in the database where the district name will be stored.
*/
'district_name' => 'name',
/**
* Local Level Model.
*
* This is the model that will be used to seed the local levels.
*/
'local_level' => '\Dipesh79\LaravelNepalAddressSeeder\src\Models\LocalLevel',
/**
* Local Level Name in the database.
*
* This is the column name in the database where the local level name will be stored.
*/
'local_level_name' => 'name',
/**
* Opt in if you want to add wards in the database.
*
* This will add the wards in the local level in the database.
*/
'add_local_level_wards' => false,
/**
* Local Level Wards in the database.
*
* This is the column name in the database where the local level wards will be stored.
*/
'local_level_wards' => 'wards',
];
```
## Model
You can use your own model, or you can model from our package.
### Province Model
NOTE: If you are using our model, make sure you have soft delete column in your migration. If you are using our published migration, then we already have it.
```php
hasMany(District::class);
}
}
```
### District Model
```php
hasMany(LocalLevel::class);
}
public function province(): BelongsTo
{
return $this->belongsTo(Province::class, 'province_id');
}
}
```
### Local Level Model
```php
belongsTo(District::class, 'district_id');
}
}
```
## Database Seeding
You can seed the database using the following command. Before seeding, make sure you have the correct model in your configuration file.
```bash
php artisan nepal-address:seed
```
Now you can use the data in your database.
## V 0.0.4 Update
Now you can add a flag to the command.
### Import Province Only
```bash
php artisan nepal-address:seed --province
```
### Import District Only
```bash
php artisan nepal-address:seed --district
```
### Import Local Level Only
```bash
php artisan nepal-address:seed --local-level
```
### TODOS
* Wards Count
## License
[MIT](https://choosealicense.com/licenses/mit/)
## Author
- [@Dipesh79](https://www.github.com/Dipesh79)
## Support
For support, email [email protected].