Skip to content

Commit

Permalink
Update Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Billmike committed Jan 29, 2019
1 parent ecedf43 commit c28eb12
Showing 1 changed file with 61 additions and 1 deletion.
62 changes: 61 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,61 @@
[![Build Status](https://travis-ci.com/Billmike/random-number-gen.svg?branch=develop)](https://travis-ci.com/Billmike/random-number-gen)
[![Build Status](https://travis-ci.com/Billmike/random-number-gen.svg?branch=develop)](https://travis-ci.com/Billmike/random-number-gen)

# Random Phone Number Generator

## Introduction

> **Random Phone Number Generator** is an application built using React and Redux, that enables the generating of random, unique phone numbers.
## Table of Content
- [Features in the application](#features-in-the-application)
- [Technology stack used](#technology-stack-used)
- [Getting Started](#getting-started)
- [Running Tests](#running-tests)

## Features in the application

* User can generate between 1 - 5000 phone numbers
* User can download the generated phone-number in .txt format
* User can sort phone numbers generated in ascending or descending order
* User can get the maximum and minimum generated phone numbers

## Technology Stack used
* ReactJS
* Redux

## Getting Started

* Before cloning the repo, make sure you have Node installed on your local machine
* Clone the repo to your local machine

```sh
> $ git clone https://github.com/billmike/random-number-gen.git
```

* Change directory into the more-recipes directory

```sh
> $ cd random-number-gen
```

* Install all required dependencies by running

```sh
> $ yarn install
```

* To start the application, run

```sh
> $ yarn start
```

## Running tests

#### Client-side tests

* To run the client-side tests, run

```sh
> $ yarn test
```

0 comments on commit c28eb12

Please sign in to comment.