azeezolaniran2016 / random-phone-number-generator

Generates random phone numbers for a telecommunications company. The phone numbers have a length of 10 digits (all starting with zero) and are always be unique

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

random-phone-number-generator

Build Status Coverage Status

Introduction

Random phone number generator is a CLI application that allows you generate random 10 digit mobile numbers each starting with zero. Along with generating the mobile numbers, it does the following:

  • All mobile numbers generated overtime are persited to a file in the current working directory.
  • All mobile numbers generated are unique in relation to all previously generated and persisted mobile numbers.

Requirements

To be able to use the application locally, the following are required:

How To Use

This can be easily installed locally through these steps:

  • Clone the repository locally
  • Run npm install to install dependent Node packages
  • Run node index.js --help to view all command and option available
  • Run node index.js <command> <--option1> <--option2> to perform a specific command

How To Test

This application can be tested locally by running npm test

Roadmap

Project Roadmap

Contributors

How to Contribute

  1. Fork this repository to your GitHub account
  2. Clone the forked repository
  3. Create your feature branch
  4. Commit your changes
  5. Push to the remote branch
  6. Open a Pull Request

Task List

  • Setup Version Control System
  • Setup CI/CD using Travis for builds and Coveralls for coverage reporting
  • Add Unit tests
  • Implement core modules - Generator, Repo, and Util
  • Add entry cli module
  • Add options to allow truncating/paginating through command results
  • Setup code style linting checks
  • More research and improve unique random number generation algorithm
  • Expose Rest conforming API
  • Improve UI/UX - Switch from CLI to Web UI

Technologies

random-phone-number-generator is implemented using a number of technologies, these include:

  • Node.JS - Evented I/O for the backend
  • commander - The complete solution for node.js command-line interfaces

About

Generates random phone numbers for a telecommunications company. The phone numbers have a length of 10 digits (all starting with zero) and are always be unique

License:MIT License


Languages

Language:JavaScript 100.0%