onedebos / naija-faker

An npm package that allows you to generate Nigerian data like names, banks, emails, states and more.

naija-faker

This package helps you generate fake Nigerian data on the fly for use in your projects.

See it on NPM

Getting Started

To get started, follow the instructions below

• install the package npm install naija-faker
• import it in your app using:

// if using ES6
import naijaFaker from "naija-faker";

// or

import {
  getFirstName,
  getLastName,
  getPerson,
  getPersonList,
  getNameList,
  getBank,
  getState,
  getPhoneNumber,
  getAddress,
} from "naija-faker";

// without ES6
const naijaFaker = require("naija-faker");

• use it!

naijaFaker.getFirstName();

Available methods

Generate an array of people with first name, last name, age, bank, state and phone number

• To generate an array of people, simply pass an amt value to getPersonList() i.e getPersonList({amt: 2})
• NB: Default amt is 5

getPersonList({ amt: 2 });
//outputs:
[
  {
    fName: "abdul",
    lName: "qadr",
    age: 40,
    email: "[email protected]",
    state: "ekiti",
    phoneNumber: "[phone]",
    address: "102b, opebi road, opebi, abakaliki",
  },
  {
    fName: "frank",
    lName: "edoho",
    age: 23,
    email: "[email protected]",
    state: "delta",
    phoneNumber: "[phone]",
    address: "223, ambeez plaza, zone 5, onne",
  },
];

Generate a random First name or Last name

• getFirstName() //=> 'abraham'
• getLastName() //=> 'fatai'

Generate a random First name or Last name that starts with a letter/letters

• getFirstName('r') //=> 'rahman'
• getLastName('bo') //=> 'bolanle'

Generate a person Object with random values for First name, Last name and Age

• NB: Default age is between 18 - 50

getPerson();
// outputs:
    {
      fName: 'abdul', lName: 'qadr', age: 20,
      email: '[email protected]', state:'ekiti',
      phoneNumber:'[phone]', address: 'plaza 1121, odunuga street, igboho'
    }

• To change the default min and max values for age, pass in min and max values as an object like below.

getPerson({ min: 20, max: 50 });
// outputs:
  {
     fName: 'abdul', lName: 'qadr', age: 40,
     email: '[email protected]', state:'ekiti', bank:'Access bank', phoneNumber:'[phone]',
     networkProvider: 'Globacom',
     address: '9329, stanton oval, kwara, kosofe'
  }

Generate an array of only names

• Simply pass amt to getNameList() e.g

  NB: Default amt is 5

getNameList({ amt: 5 });

Generate a random Nigerian state

• Simply call getState() //=> 'Ondo'

Generate a bank name

• Simply call getBank() //=> 'Access Bank'

Generate an address

• Simply call getAddress() //=> 'Plot 83, Nasarawa, Bauchi'

Generate a phone number

• Simply call getPhoneNumber() //=> '[phone]'

Test

• To run the tests

npm install
npm test

Authors

👤 Adebola Adeniran

• Github: @githubhandle
• Twitter: @twitterhandle
• Linkedin: linkedin
• Web: Adebola

🤝 Contributors

👤 Mayank Bucha

• Github: @githubhandle
• Linkedin: linkedin
• Email: gmail

👤 Nikhil Chaurasia

• Github: Github
• Linkedin: linkedin
• Email: Gmail

Show your support

Give a ⭐️ if you like this project!

Acknowledgments

📝 License

This project is MIT licensed.

naija-faker's Issues

Address

Add house address

Fix letterStartsWith parameter insdiet getFirstName to not limit string to 1

• Inside the getFirstName function, users should be able to pass any string length they want their names to start with and shouldn't be limited to just a length of 1.

Refactor getFirstName and getLastName

Extract getFirstName and getLastName into a seperate function that can be reused since the logic is the same.

Set mobile network based on Phone number prefix

Generate the name of a mobile network provider based on the phone number prefix.

Mobile network providers in Nigeria and their respective prefixes can be obtained here
https://en.wikipedia.org/wiki/Telephone_numbers_in_Nigeria

Phone numbers

• Write a function to Generate phone numbers using JS Math.random method instead of using an array of phone numbers.

• Pay attention to generating numbers based on PREFIXES listed here:
  https://en.wikipedia.org/wiki/Telephone_numbers_in_Nigeria#Mobile_phone_network_prefixes_[1]

• Generate numbers for only GLO, MTN, 9mobile and Airtel.

Add phone number

Generate phone numbers based on mobile network

Add account number

Add account numbers based on banks generated

Add tests

Implement tests