mwaz/phone-number-generator

A phone number generator application

Random Phone Number Generator

A CRUD API app built with node, express, and localstorage

The Express JS framework handles the API CRUD, localStorage handles the storage of data. the stored data is then transferred to an external file on user request

Requirements

• NodeJS

• express framework

What the app does

The API enables a user generate unique phone numbers everytime. they can then receive realtime updates on the numbers they have generated, the maximum number and the minimum numbers. The users can also delete hte numbers and sort the numbers in either ascending or descending orders. For efficiency local storage ensures that the company using the system does not incur extra charges for the file storage in terms of a database.

Application setup

The Phone generator API is hosted on heroku and you can access the documentation here. Through the docs you can test out the endpoints and the functionnality of the API.

Running the application locally

1. clone the application from git@github.com:mwaz/sms-mgt-api.git
2. Install dependencies using npm ci or npm install
3. Start the application npm start

Running the test locally

1. clone the application from git@github.com:mwaz/sms-mgt-api.git
2. Install dependencies using npm ci or npm install
3. run the tests using npm test

Technologies

Technologies used in the application are Express and Node.

Documentation

The app is currently documented using swagger 2.0 and the Open API Specification as shown below .

contributors

@mwaz