nodezoo.com micro-service handling Coveralls meta data
npm install nodezoo-coveralls![logo-nodezoo][Logo]
- __Lead:__ [Mihai Dima][Lead]
- __Sponsor:__ [nearForm][Sponsor]
A microservice that provides Coveralls data for [NodeZoo org][]. This microservice depends
on [Coveralls][] and the NPM registry but also caches retrieved data to reduce load on both
public registries.
Please see the [Nodezoo System][System] for more details.
If you're using this microservice, and need help, you can:
- Post a [github issue][Issue],
- Tweet to [@nodezoo][Twitter],
- Ask on the [Gitter][Gitter].
npm installThis micro-service can be ran as part of a complete system or as a single isolated
unit.
- [Nodezoo: The complete system][System]
To run in isolated mode:
- Clone this repository locally,
- Run npm install,
- Run npm start isolated.
A simple http service is supported and can be called using Curl or other Rest clients.
The default port is 8054. It can be changed using the COVERALLS_PORT environment
variable.
Any of the messages above can be run using curl in the following format in the command line
```
curl -d '{"role":"coveralls","cmd":"get","name":"YOUR_TEXT_HERE"}' http://localhost:8054/actConfiguration
#### COVERALLS_HOST
- The host to listen on in isolated mode or the host to be published in the Mesh network.
- Defaults to localhost in isolated mode and to 127.0.0.1 in a Mesh network.
#### COVERALLS_PORT
- The port to listen on in isolated mode.
- Defaults to 8054.
#### COVERALLS_REDIS_HOST
- The host redis listens on.
- Defaults to localhost.
#### COVERALLS_REDIS_PORT
- The port redis listens on.
- Defaults to 6379.
#### COVERALLS_ISOLATED
- Starts isolated mode.
- Defaults to false.
#### COVERALLS_REGISTRY
- Changes the Coveralls URL used to retrieve the module info.
- Defaults to https://coveralls.io/.
#### NPM_REGISTRY
- Changes the npm registry used to retrieve the module info.
- Defaults to http://registry.npmjs.org/.
#### BASE_HOST
- Mesh Base location.
- Defaults to 127.0.0.1:39999.
`jsrole:coveralls,cmd:get
seneca.act(, {name:'seneca'}, (err, data) => {})`
, allows integration into the wider nodezoo-system.`js
seneca.act(role:info,req:part, {name:'seneca'}, (err, reply) => {})
`Messages Emitted
$3
Called in response to a call to
role:info,req:part.`js
seneca.add(role:info,res:part, (msg, done) => {})
``- [Code of Conduct][CoC]
If you feel you can help in any way, be it with documentation, examples, extra testing, or new
features please get in touch.
[BadgeCoveralls]: https://coveralls.io/repos/github/nodezoo/nodezoo-coveralls/badge.svg?branch=master
[BadgeTravis]: https://travis-ci.org/nodezoo/nodezoo-coveralls.svg
[BadgeGitter]: https://badges.gitter.im/Join%20Chat.svg
[BadgeNpm]: https://badge.fury.io/js/nodezoo-coveralls.svg
[Coveralls]: https://coveralls.io/github/nodezoo/nodezoo-coveralls?branch=master
[CoC]: https://github.com/nodezoo/nodezoo-org/blob/master/CoC.md
[Gitter]: https://gitter.im/nodezoo/nodezoo-org
[Travis]: https://travis-ci.org/nodezoo/nodezoo-coveralls
[Logo]: https://raw.githubusercontent.com/nodezoo/nodezoo-org/master/assets/logo-nodezoo.png
[Npm]: http://npmjs.org/nodezoo-coveralls
[Sponsor]: http://nearform.com
[Lead]: https://github.com/mihaidma
[NodeZoo org]: https://github.com/nodezoo
[Lic]: ./LICENSE
[Issue]: https://github.com/nodezoo/nodezoo-coveralls/issues
[Twitter]: http://twitter.com/nodezoo
[System]: https://github.com/nodezoo/nodezoo-system