\n Event-sourced autonomous service toolkit for Node.js\n
\n
\n \n \n \n
\n\n## Install\n\n```\nyarn add @articulate/hermes\n```\n\n## Setup\n\nFollow the [setup instructions](https://github.com/message-db/message-db) for Message DB to initialize the message store, or use [this Docker image](https://hub.docker.com/r/articulate/message-db) for local dev. Then provide connection options as below:\n\n```js\n// server/lib/hermes.js\n\nmodule.exports = require('@articulate/hermes')({\n connectionString: process.env.MESSAGE_STORE_URI\n})\n```\n\nYou'll need at least a `connectionString`, but see the following for the full list of available options:\n- https://node-postgres.com/api/client\n- https://node-postgres.com/api/pool\n\n**Note:** You may alternatively specify the connection options using [standard Postgres environment variables](https://www.postgresql.org/docs/current/libpq-envars.html).\n\n## Documentation\n\nSee the full documentation here: https://articulate.github.io/hermes/\n\nYou can also host the docs locally by cloning the repo and running:\n\n```\nnpm i docsify-cli -g\nyarn docs\n```\n\nLocal docs will then be available at: http://localhost:4000\n\n## Logging\n\nHermes uses the [`debug`](https://github.com/visionmedia/debug) library to output raw logs. To turn on all of the logs, include the following environment variable:\n\n```\nDEBUG=hermes:*\n```\n\nWhen debugging locally, these additional variables may also help. See the `debug` docs for [the full list of options](https://github.com/visionmedia/debug/#environment-variables).\n\n```\nDEBUG_COLORS=true\nDEBUG_DEPTH=null\nDEBUG_HIDE_DATE=true\n```\n\n## Mocking\n\nTo help you test your [autonomous services](https://articulate.github.io/hermes/#/core-concepts?id=service), Hermes ships with an in-memory substitute that passes [the same test suite](https://github.com/articulate/hermes/tree/master/test) as the default Message DB implementation. Enable it with the `{ mock: true }` flag. When enabled, Hermes will ignore any connection options specified, and will not connect to Postgres.\n\nIn addition, you may clear the in-memory store after each test using `hermes.store.clear()`.\n\n```js\nconst hermes = require('@articulate/hermes')({\n mock: process.env.NODE_ENV === 'test'\n})\n\nafterEach(() => {\n hermes.store.clear()\n})\n```\n\n**Read more** about testing with Hermes in the section on [entity caching](https://articulate.github.io/hermes/#/api?id=caching).\n\n> **Not for production use.** The in-memory substitute implementation is only intended for testing.\n\n## Tests\n\nThe [Hermes tests](https://github.com/articulate/hermes/tree/master/test) run in [Travis CI](https://travis-ci.org/github/articulate/hermes), but you can run the tests locally with `docker-compose` like so:\n\n```\ndocker-compose build\ndocker-compose run --rm test\n```\n","readmeFilename":"README.md"}
![](\"https://user-images.githubusercontent.com/888052/77281533-a7da7a80-6c9d-11ea-874c-66475fa89d53.png\"/)
\n \n![\"npm](\"https://img.shields.io/npm/v/@articulate/hermes\")
![\"npm](\"https://img.shields.io/npm/dm/@articulate/hermes\")
![\"Build](\"https://travis-ci.org/articulate/hermes.svg?branch=master\")
\n