Merge fc31696 into c794613

README.md

@@ -1,13 +1,15 @@
-# andela-teams-2
+# taps-client
+This is the client side for [Andela TAPS](https://ghoulies-taps-client.herokuapp.com/).
+
 [![Andela](https://andela-badge.herokuapp.com/)](https://andela.com)
 [![Build Status](https://travis-ci.org/andela/taps-client.svg?branch=staging)](https://travis-ci.org/andela/taps-client)
 [![Coverage Status](https://coveralls.io/repos/github/andela/taps-client/badge.svg?branch=code-coverage-integration-158580405)](https://coveralls.io/github/andela/taps-client?branch=code-coverage-integration-158580405)
 [![Hound CI](https://camo.githubusercontent.com/23ee7a697b291798079e258bbc25434c4fac4f8b/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f50726f7465637465645f62792d486f756e642d6138373364312e737667)](https://houndci.com)
 
 
-Andela Teams seeks to automate some of the routine actions taken by __simulations learning facilitators__ at Andela.
+Andela Taps seeks to automate some of the routine actions taken by __simulations learning facilitators__ at Andela.
 
-Here is a useful scenario. When a new cohort (class) begins simulations (*sims*) at Andela, the cohort is broken into teams, and each team is assigned to a learning facilitator. The learning facilitator then creates a few Slack channels, a Github repo, and a Pivotal Tracker board. For each of these, the facilitator has to add every member of the team to the channel/repo/board. This is obviously a task that should be automated, especially considering that even the names of the channels/repo/board are always in a particular format. Andela Teams seeks to automate these and many more routine tasks performed by facilitators.
+Here is a useful scenario. When a new cohort (class) begins simulations (*sims*) at Andela, the cohort is broken into teams, and each team is assigned to a learning facilitator. The learning facilitator then creates a few Slack channels, a Github repo, and a Pivotal Tracker board. For each of these, the facilitator has to add every member of the team to the channel/repo/board. This is obviously a task that should be automated, especially considering that even the names of the channels/repo/board are always in a particular format. Andela Taps seeks to automate these and many more routine tasks performed by facilitators.
 
 ## Technologies Used
 ### Frontend
@@ -16,6 +18,32 @@ Here is a useful scenario. When a new cohort (class) begins simulations (*sims*)
 - [Webpack](https://webpack.js.org/) A JavaScript tool for bundling scripts, images, styles and other assets
 - [Babel](https://babeljs.io/) A JavaScript compiler for converting codes written in ES6 or JSX to ES5 that is supported by many browsers
 
+## Usage
+
+### Prerequisites ###
+You are going to need
+
+* Linux, macOS or Windows
+* node version 8.9.2
+
+### Getting Set Up ###
+* Clone this repository to your local machine
+```
+$ https://github.com/andela/taps-client.git
+```
+* Change directory into the taps-client directory
+```
+$ cd taps-client
+```
+* Install all required dependencies by running
+```
+$ npm install
+```
+* Once installation is done, create a .env file and fill it with the neccessary environment variables **(see .env-sample for the neccessary environment variables required)**
+* To start the application, run
+```
+npm run dev
+```
 ## Testing
 
 This project uses [jest](https://jestjs.io/) for testing.