p632-sp-2016/eDocLite

View on GitHub
README.md

Summary

Maintainability
Test Coverage
[![Travis CI](https://travis-ci.org/p632-sp-2016/eDocLite.svg?branch=master)](https://travis-ci.org/p632-sp-2016/eDocLite)
[![Code Climate](https://codeclimate.com/github/p632-sp-2016/eDocLite/badges/gpa.svg)](https://codeclimate.com/github/p632-sp-2016/eDocLite)
[![Test Coverage](https://codeclimate.com/github/p632-sp-2016/eDocLite/badges/coverage.svg)](https://codeclimate.com/github/p632-sp-2016/eDocLite/coverage)
[![Issue Count](https://codeclimate.com/github/p632-sp-2016/eDocLite/badges/issue_count.svg)](https://codeclimate.com/github/p632-sp-2016/eDocLite)
[![Document Coverage](https://doc.esdoc.org/github.com/p632-sp-2016/eDocLite/badge.svg)](https://doc.esdoc.org/github.com/p632-sp-2016/eDocLite) 
# eDocLite
This is the eDocLite project made under UITS for the P632 course.

Website : [http://p632-sp-2016.github.io/eDocLite/](http://p632-sp-2016.github.io/eDocLite/ "eDocLite Homepage")

Documentation : [https://doc.esdoc.org/github.com/p632-sp-2016/eDocLite/](https://doc.esdoc.org/github.com/p632-sp-2016/eDocLite/ "eDocLite Documentation")

Presentation Links : [Week 1](http://p632-sp-2016.github.io/eDocLite/presentations/week1/ "Week 1 Presentation") | [Week 2](http://p632-sp-2016.github.io/eDocLite/presentations/week2/ "Week 2 Presentation") | [Week 3](http://p632-sp-2016.github.io/eDocLite/presentations/week3/presentation.pptx "Week 3 Presentation") | [Week 4](http://p632-sp-2016.github.io/eDocLite/presentations/week4/presentation.pptx "Week 4 Presentation") | [Week 7](http://p632-sp-2016.github.io/eDocLite/presentations/week7/eDocLite.pptx "Week 7 Presentation")

Steps to Run:

1) Install Dependencies
```
npm install
```

2) Run Application
```
npm start
```

3) Stop Application
```
npm stop
```

Steps to Test: 

Start Karma Server
```
npm test
```

Steps to generate documents using esdoc: 
```
npm docs
```

Steps for using eslint:
```
npm lint
```

Steps to generate documentation using esdoc hosting service:

1. Go to: [https://doc.esdoc.org/-/generate.html](https://doc.esdoc.org/-/generate.html "https://doc.esdoc.org/-/generate.html")

2. Input: "git@github.com:p632-sp-2016/eDocLite.git"

3. Click the "Generate" button

4. View documentation on: [https://doc.esdoc.org/github.com/p632-sp-2016/eDocLite/](https://doc.esdoc.org/github.com/p632-sp-2016/eDocLite/ "https://doc.esdoc.org/github.com/p632-sp-2016/eDocLite/")