README

This will help to get data about local states in Nepal based on recent administrative division

Image Source: Wikipedia(Administrative divisions of Nepal)

Description

Local States Nepal is the php composer package to get structured dataset about local states in Nepal.

Local States Nepal requires

PHP >= 7.0

Version v1.0.8 has been tested on following php versions:

• 7.0
• 7.1
• 7.2
• 7.3
• 7.4

Version v2.0.0 has been tested on following php versions:

• 8.0
• 8.1
• 8.2
• 8.3

Version v2.0.1 has been tested on following php versions:

• 8.4

Version v2.1.0 has been tested on following php versions:

• 8.5

Demo

You can view Province -> District -> Municipality -> Wards in following demo.

How to set up demo ?

You can find all source code for demo inside demo directory. You can clone this repository in your server and then visit following url:

local_server_url/local-states-nepal/demo/

Example: http://127.0.0.1/local-states-nepal/demo

Demo Video:

https://www.loom.com/share/a8c3d825a9ee41a9817b24645453e979

Additionally, you can setup with Docker and visit localstates.test to view the demo. Here is guideline for setting up with Docker.

Local setup with Docker

Support

Currently, This library supports following two languages.

• English
• नेपाली

Installation

composer require sagautam5/local-states-nepal

Configuration

Currently, No mandatory configuration is required for using this package. We have used english as the default language and if you want nepali you have to specify the language while using this package.

About Dataset

All data are collected from wikipedia and various Nepal government sites. We have data set in Nepali and English format for following four entities.

1. Province
2. District
3. Municipality
4. Category
5. Nested Data Set

You can see more details about data in the link provided in above list.

Basic Usage

After installation, you can use features like this:

use Sagautam5\LocalStateNepal\Entities\Province;

$province = new Province('np');

// Get List of all Provinces
$provincesData = $province->allProvinces();

// Get List of All Provinces with District
$provincesData = $province->getProvincesWithDistricts();

// Get List of All Provinces with District and Districts with Municipalities
$provincesData = $province->getProvincesWithDistrictsWithMunicipalities();

NOTE: Default language is 'en' and if you want 'np' then you have to specify language while creating class object.

You can see more detail documentation of each entity in the links provided in following list.

1. Provinces
2. Districts
3. Municipality
4. Category

Security

If you discover a security vulnerability within this package, please send an e-mail to sagautam5@gmail.com, All security vulnerabilities will be promptly addressed.

🤝 Contributing

Please see CONTRIBUTING for details.

📄 License

The MIT License (MIT). Please see License File for more information.