Directory App

Table of Contents

• Project Overview
• Features
• Demo
• Dependencies
• Setup
• Contributing
• License

Project Overview

Directory App is a simple Application which shows the listing of individuals generated ramdomly and their details. It was built from scratch using Html , Css and react

Features

• List of contacts sorted Alphabetically.
• On click each contact to see more details about the individual.

Demo

Visit App on Heroku

Dependencies

• Node - A Javascript runtime environment.
• React - A Javascript library for building user interfaces.
• Enzyme - A Javascript testing utility for React
• Webpack - A Javascript module bundler
• A package manager - yarn or NPM

Setup

• $ git clone https://github.com/fire-cracker/directory-app.git
• $ cd directory-app
• Add env file and setup using the env.sample file

To install dependencies:

$ npm install or $ yarn install

This will install all the requirements defined in the package.json file inside the directory-app folder.

Start local server:

$ npm start-dev

Testing the app

$ npm test

Documentation

$ npm run docs

Contributing

Feel free to 🍴 fork this repository

👯 Clone this repository to your local machine using https://github.com/fire-cracker/directory-app.git

Make Contributions

🔃 Create a new pull request using https://github.com/oyedejipeace/SendIT-react./compare

License

• Copyright 2018 © SendIT