[](https://travis-ci.org/smartcitiesdata/divo_redis)
[](https://hex.pm/packages/divo_redis)
# Divo Redis
A library implementing the Divo Stack behaviour, providing a pre-configured redis
via docker-compose for integration testing Elixir apps. The cluster is a
single-node redis compose stack that neither requires (nor accepts) no further configuration.
Requires inclusion of the Divo library in your mix project.
## Installation
The package can be installed by adding `divo_redis` to your list of dependencies in `mix.exs`:
```elixir
def deps do
[
{:divo, "~> 2.0.0"},
{:divo_redis, "~> 1.0.0"}
]
end
```
## Use
In your Mix environment exs file (i.e. config/integration.exs), include the following:
```elixir
config :myapp,
divo: [
{DivoRedis, []}
]
```
In your integration test specify that you want to use Divo:
```elixir
use Divo
...
```
The resulting stack will create a single-node Redis instance exposing port 6379
to the host.
### Configuration
DivoRedis takes no configuration.
See [Divo GitHub](https://github.com/smartcitiesdata/divo) or [Divo Hex Documentation](https://hexdocs.pm/divo) for more instructions on using and configuring the Divo library.
See [antirez/redis](https://github.com/antirez/redis) for further documentation on using
and configuring the features of these images.
Documentation can be generated with [ExDoc](https://github.com/elixir-lang/ex_doc)
and published on [HexDocs](https://hexdocs.pm). Once published, the docs can
be found at [https://hexdocs.pm/divo_redis](https://hexdocs.pm/divo_redis).
## License
Released under [Apache 2 license](https://github.com/smartcitiesdata/divo_redis/blob/master/LICENSE).
