Skip to content
The common API for all apps
JavaScript
Branch: master
Clone or download

Latest commit

Fetching latest commit…
Cannot retrieve the latest commit at this time.

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
config
data
lib
models
routes
scripts
test
.gitignore
.snyk
.travis.yml
LICENSE
README.md
package.json
server.js

README.md

Build Status Gitter chat Codacy Badge Known Vulnerabilities

API

The common API for all aiims apps

How to

You should have NodeJS(v6.6.0 or above) and MongoDB installed and running

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.
  • You can fill and empty the sample data with npm run filldb and npm run emptydb respectively.

Documentation

npm install
npm run gendoc

Open index.html in docs/ for API reference

Authors

The BITS AIIMS students

License

MIT

You can’t perform that action at this time.