Merge pull request #47 from teamtaverna/9__update_webclient_readme

Update readme, add link to coveralls and travis

.travis.yml

@@ -10,6 +10,8 @@ script:
   - npm test
   - npm build
 
+after_success: npm run coverage
+
 notifications:
   slack: teamtaverna:iP55LweubU8UOBgu9e0cTeED
 

README.md

@@ -1,2 +1,38 @@
-# tarvena-admin
-The admin interface for Tarvena app.
+[![Coverage Status](https://coveralls.io/repos/github/teamtaverna/web_client/badge.svg)](https://coveralls.io/github/teamtaverna/web_client) [![Build Status](https://travis-ci.org/teamtaverna/web_client.svg?branch=master)](https://travis-ci.org/teamtaverna/web_client)
+
+# Web Client
+The web interface for Tarvena app, an open source meal review and management platform.
+
+### Tech
+- NodeJS
+- ReactJS
+- webpack
+
+### Collaboration
+
+Want to contribute? Great!
+
+Clone the repository from [GitHub](https://www.github.com)
+```
+$ git clone https://github.com/teamtaverna/web_client.git
+```
+
+### Installation
+
+**Mac Users**
+
+Be sure to have the following installed and setup first.
+* NodeJS
+
+Next,
+- install the dependencies
+
+```
+npm install
+```
+
+To start the server
+
+```
+npm run dev
+```

package.json

@@ -18,7 +18,7 @@
     "build:client": "webpack --verboose --colors --display-error-details --config webpack/prod.config.js",
     "test": "mocha \"src/**/**/*.test.*\" --require test/.setup.js",
     "stylelint": "stylelint --config .stylelintrc \"src/**/**/*.scss\"",
-    "coverage": "istanbul cover _mocha  \"src/**/**/*.test.*\" --require test/.setup.js"
+    "coverage": "node_modules/.bin/babel-node node_modules/.bin/istanbul cover node_modules/mocha/bin/_mocha  \"src/**/**/*.test.*\" -- --compilers js:babel-core/register --colors --reporter dot test/ --require test/.setup.js src/**/* && cat ./coverage/lcov.info | ./node_modules/coveralls/bin/coveralls.js"
   },
   "repository": {
     "type": "git",
@@ -69,10 +69,13 @@
   },
   "devDependencies": {
     "babel-eslint": "^7.0.0",
+    "coveralls": "^2.11.16",
     "eslint-config-airbnb": "^12.0.0",
     "eslint-plugin-import": "^2.0.1",
     "eslint-plugin-jsx-a11y": "^2.2.2",
     "eslint-plugin-react": "^6.3.0",
+    "istanbul": "^1.0.0-alpha.2",
+    "mocha-lcov-reporter": "^1.2.0",
     "piping": "^1.0.0-rc.4",
     "postcss-loader": "^1.1.1",
     "sass-loader": "^4.0.2",

test/.setup.js

@@ -31,5 +31,7 @@ require.extensions['.svg'] = noop;
 require.extensions['.jpg'] = noop;
 require.extensions['.jpeg'] = noop;
 require.extensions['.gif'] = noop;
+require.extensions['.svg'] = noop;
+
 
-var documentRef = document;
+var documentRef = document;