https://github.com/adarshaacharya/states-nepal
Get structured data about administrative division in Nepal.
https://github.com/adarshaacharya/states-nepal
hacktoberfest hacktoberfest-accepted hacktoberfest2021 nepal nodejs npm-package states-nepal typescript
Last synced: 6 months ago
JSON representation
Get structured data about administrative division in Nepal.
- Host: GitHub
- URL: https://github.com/adarshaacharya/states-nepal
- Owner: adarshaacharya
- License: mit
- Created: 2021-01-08T15:30:22.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2024-12-30T07:05:12.000Z (10 months ago)
- Last Synced: 2025-04-08T09:06:19.423Z (6 months ago)
- Topics: hacktoberfest, hacktoberfest-accepted, hacktoberfest2021, nepal, nodejs, npm-package, states-nepal, typescript
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/states-nepal
- Size: 622 KB
- Stars: 23
- Watchers: 2
- Forks: 5
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
states-nepal
🇳🇵 Get structured data about administrative division in Nepal.
Report Bug
·
Request Feature
·
Ask Question
states-nepal is a npm package that helps to get the dataset about different administrative division of Nepal like provinces, districts, categories,etc. Install and use the package on any Javascript/Typescript based on Node.js or browser environment!
## Installation
```bash
$ npm install states-nepal
```
## Support
**Applications :**
- Node.js
- Browsers
**Import :**
- CommonJS Module
- ES Module
**Languages :**
- English
- नेपाली
## Documentation
There are two documentations ready for this package :
#### Data Docs
All data are collected from wikipedia and various Nepal government sites. We have data set in Nepali and English format for following four entities. Explore more details about data by checking following docs.
- [Provinces](./docs/data/provinces.md)
- [Districts](./docs/data/districts.md)
- [Municipalities](./docs/data/municipalities.md)
- [Categories](./docs/data/categories.md)
#### Usage Docs
See the how to implement the package on your Javascript applications on following docs:
- [Provinces](./docs/usage/provinces.md)
- [Districts](./docs/usage/districts.md)
- [Municipalities](./docs/usage/municipalities.md)
- [Categories](./docs/usage/categories.md)
## Release Notes
Read [Change Log](CHANGELOG.md) for complete logs.
## Contributing
I would love to have some of your contributions to this project. You can checkout [Contributing Guide](CONTRIBUTING.md) for Contribution guidelines.
## Contributors
This package is inspired from the Php composer package [local-states-nepal](https://github.com/sagautam5/local-states-nepal). Massive thanks to [Sagar Gautam](https://github.com/sagautam5) for providing the dataset.
## Show your support
Give a ⭐️ if you like the project! :tada:
## Author
- Website:
- Twitter: [@adarsha_ach](https://x.com/adarsha_ach)
- Github: [@adarshaacharya](https://github.com/adarshaacharya)
- LinkedIn: [@adarshaacharya](https://linkedin.com/in/adarshaacharya)
## License
Copyright © 2021 [Aadarsha Acharya](http://adarsha.dev/).
This project is [MIT](https://github.com/adarshaacharya/states-nepal/blob/master/LICENSE) licensed.