https://github.com/knowbee/murwanda
🇷🇼Find place codes by code, province, district, sector, cell or village name from Rwanda
https://github.com/knowbee/murwanda
cells districts place-code rwanda sectors village
Last synced: 5 months ago
JSON representation
🇷🇼Find place codes by code, province, district, sector, cell or village name from Rwanda
- Host: GitHub
- URL: https://github.com/knowbee/murwanda
- Owner: knowbee
- Created: 2020-05-15T09:55:25.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2020-07-20T18:01:06.000Z (almost 6 years ago)
- Last Synced: 2025-08-09T11:30:42.589Z (10 months ago)
- Topics: cells, districts, place-code, rwanda, sectors, village
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/murwanda
- Size: 1.02 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
Awesome Lists containing this project
README
# murwanda
[](https://travis-ci.com/knowbee/murwanda)
[](https://www.npmjs.com/package/murwanda)
[](https://david-dm.org/knowbee/murwanda)
[](https://www.npmjs.com/package/murwanda)
[](https://github.com/ellerbrock/open-source-badge/)
[](https://github.com/ellerbrock/open-source-badge/)
murwanda is an alternative to [rwanda](https://nodei.co/npm/rwanda/), with this package you get access to place codes for all locations(provinces,districs,sectors,cells,villages) from Rwanda
## Install
```cli
npm install murwanda
```
or
```cli
yarn add murwanda
```
## Example
```js
const { PlaceCodesByProvince, PlaceCodesByCode } = require("murwanda");
console.log(PlaceCodesByProvince("South"));
console.log(PlaceCodesByCode("102130307")) // 102130307 : village code
// [
// {
// province_code: '1',
// province_name: 'Kigali City',
// district_code: '102',
// district_name: 'Gasabo',
// sector_code: '010213',
// sector_name: 'Remera',
// cell_code: '1021303',
// cell_name: 'Rukiri I',
// village_code: '102130307',
// village_name: 'Urumuri'
// }
// ]
```
## Usage
```js
const { PlaceCodesByProvince, PlaceCodesByDistrict, PlaceCodesBySector, PlaceCodesByCell, PlaceCodesByVillage, PlaceCodesByCode } = require("murwanda");
```
All inputs are case-insensitive.
## Methods
#### PlaceCodesByProvince(province)
Returns array of all places(province, districts, sectors, cells, villages) and their respective codes from the given province.
#### PlaceCodesByDistrict(province, district)
Returns array of all places(province, district, sectors, cells, villages) and their respective codes from the given district.
#### PlaceCodesBySector(province, district, sector)
Returns array of all places(province, district, sector, cells, villages) and their respective codes.
#### PlaceCodesByCell(province, district, sector, cell)
Returns array of all places(province, district, sector, cell, villages) and their respective codes.
#### PlaceCodesByVillage(province, district, sector, cell, village)
Returns array of all places(province, district, sector, cell, village) and their respective codes.
#### PlaceCodesByCode(code)
Returns array of all places(province, district, sector, cell, village) and their respective codes.
# Contribution
- Please before making a PR, read first this [Contributing Guideline](./CONTRIBUTING.md)
## License
MIT
## Author
Igwaneza Bruce