npms-api
The https://npms.io API.
You may read the API documentation in https://api-docs.npms.io.
The API is available under https://api.npms.io/v<version>
, where version
may be:
2
(current)1
(deprecated, will become unavailable on2016-12-19
Development
Simply spawn the server by running $ npm run start-dev
.
Deploys
There's a separate document that explains the deployment procedure, you may read it here.
Documentation
You may update the API REST documentation by running $ npm run docs
and previewing docs/apidoc/index.html
in your browser.
To push any changes in the documentation run $ npm run docs-push
.
Tests
$ npm test
$ npm test-cov # to get coverage report
License
Released under the MIT License.