kodefarmers/nepaldata

A laravel package to fetch Nepal data (Provinces, Districts, Municipalities).

v1.1.1 2024-07-25 03:33 UTC

Requires (Dev)

• orchestra/testbench: ^9.0.4

MIT

• Shivaji Chalise

README

NepalData is a laravel package that provides easy access to information about Nepal: Provinces, Districts, Municipalities. With this package, you can quickly and easily retrieve data about Nepal to use in your Laravel application.

Installation

You can install the package via Composer:

$ composer require kodefarmers/nepaldata

The Laravel facade and service provider are registered through auto-discovery, so you can instantly start using it.

Usage

This package publishes a Laravel facade for easier usage:

use KodeFarmers\NepalData\Facades\NepalData;

return NepalData::all(); // returns all data i.e provinces with its districts with its localbodies
return NepalData::all('devanagari'); // returns all data in nepali text

return NepalData::provinces(); // get all provinces
return NepalData::provinces('devanagari'); // get all provinces in nepali text

return NepalData::with('districts')->provinces(); // get all provinces with districts
return NepalData::with('districts')->provinces('devanagari'); // get all provinces with districts in nepali text

return NepalData::districts(); // get all districts
return NepalData::districts('devanagari'); // get all districts in nepali text

return NepalData::with('localbodies')->districts(); // get all districts with localbodies
return NepalData::with('localbodies')->districts('devanagari'); // get all districts with localbodies in nepali text

Example:

return NepalData::all(); // it'll return:
{
  "Province No. 1": {
    "Taplejung": {
      "Ma.Na.Pa.": [],
      "Upa.Ma.": [],
      "Na.Pa.": [
        "Taplejung(Phungling)"
      ],
      "Ga.Pa.": [
        "Sirijangha",
        "AathraiTriveni",
        "PathibharaYangwarak",
        "Meringden",
        "Sidingwa",
        "Phaktanglung",
        "MaiwaKhola",
        "MikwaKhola"
      ]
    },
    .
    .

Contributing

We welcome contributions from the community! If you have an idea for a new feature or improvement, please submit a pull request. We also appreciate bug reports and other feedback.

To get started with contributing, simply fork this repository, make your changes, and submit a pull request.

License

This project is licensed under MIT

Self-Promotion

Star the repository on Github

Follow on Github