[![Build Status](https://travis-ci.org/BitsAiims2017/api.svg?branch=master)](https://travis-ci.org/BitsAiims2017/api)
[![Gitter chat](https://badges.gitter.im/BitsAiims2017/api.png)](https://gitter.im/BITS-Developers/Lobby)


# API
The common API for all aiims apps


### How to
You should have NodeJS and MongoDB installed and running
```bash
git clone https://github.com/BitsAiims2017/api
cd api
npm install && npm start
```


### Contributing
- Please use **4 SPACES**, no TABS.
- Fork and open a pull request with the changes
- Follow the code style used in the project already and ask on gitter if in
doubt.
- Please run ```npm test``` to check that all tests pass before opening a pull request.


### Documentation
```bash
npm install
npm run-script gendoc
```
Open ```index.html``` in ```docs/``` for API reference


### Authors
The BITS AIIMS students


### License
MIT

[![Build Status](https://travis-ci.org/BitsAiims2017/api.svg?branch=master)](https://travis-ci.org/BitsAiims2017/api)
[![Gitter chat](https://badges.gitter.im/BitsAiims2017/api.png)](https://gitter.im/BITS-Developers/Lobby)
[![Codacy Badge](https://api.codacy.com/project/badge/Grade/ceb3c67ab4004c4ebeb8413a823dcc22)](https://www.codacy.com/app/UtkarshMe/api?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=BitsAiims2017/api&amp;utm_campaign=Badge_Grade)


# API
The common API for all aiims apps


### How to
You should have NodeJS and MongoDB installed and running
```bash
git clone https://github.com/BitsAiims2017/api
cd api
npm install && npm start
```


### Contributing
- Please use **4 SPACES**, no TABS.
- Fork and open a pull request with the changes
- Follow the code style used in the project already and ask on gitter if in
doubt.
- Please run ```npm test``` to check that all tests pass before opening a pull request.


### Documentation
```bash
npm install
npm run-script gendoc
```
Open ```index.html``` in ```docs/``` for API reference


### Authors
The BITS AIIMS students


### License
MIT

Add Codacy code quality badge
Add Codacy code quality badge
