Code Monkey home page Code Monkey logo

naija-state-local-government's Introduction

naija-state-local-government

NPM

npm version

A simple utility library that lists Nigeria states and local governments with zero dependency

Installation

npm install naija-state-local-government

Example

//ES5
const NaijaStates = require('naija-state-local-government');

// ES6
import NaijaStates from 'naija-state-local-government';

console.log(NaijaStates.all());
console.log(NaijaStates.states());
console.log(NaijaStates.lgas("Oyo"))

Sample Usage

States

alt

LGAs

alt

function argument response
.all() none it returns all states and local government
.states() none it returns all Nigeria states
.lga(state) state(Nigeria state. Note: it's not case sensitive) it returns the local government of the input state.

Features

List all local government areas and state in Nigeria

Contributing

  • Fork this repositry to your account.
  • Clone your repositry: git clone [email protected]:your-username/naija-state-local-government.git
  • Create your feature branch: git checkout -b feature/<3-4 word feature description>
  • Commit your changes: git commit -m "feature(scope): (subject) (body) (footer)"
  • Push to the remote branch: git push origin new-feature
  • Open a pull request.
  • Commit Message Convention
    • scope should be something specific to the commit change e.g logo

    • subject text should:

      • use present tense: "save" not "saved" or "saving"
      • not capitalize first letter i.e no "Carry to safety"
      • not end with a dot (.)
    • Message body (optional) If a body is to be written, it should:

      • written in present tense.
      • include reason for change and difference in the previous behaviour
    • Message Footer This should be used for referencing the issues using the following keywords: Start, Delivers, Fixes and Finishes. It should be written as:

      • [Start #345]

License

This project is authored by Philips Blessing and is licensed for your use, modification and distribution under the MIT license.

naija-state-local-government's People

Contributors

atomicman57 avatar akinjide avatar adexphem avatar seyi-adeleke avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.