An open API service indexing awesome lists of open source software.

https://github.com/sage/cache_store_redis


https://github.com/sage/cache_store_redis

Last synced: 6 months ago
JSON representation

Awesome Lists containing this project

README

          

# CacheStoreRedis

[![Maintainability](https://api.codeclimate.com/v1/badges/c6a9256278881eab8328/maintainability)](https://codeclimate.com/github/Sage/cache_store_redis/maintainability)
[![Test Coverage](https://api.codeclimate.com/v1/badges/c6a9256278881eab8328/test_coverage)](https://codeclimate.com/github/Sage/cache_store_redis/test_coverage)
[![Gem Version](https://badge.fury.io/rb/cache_store_redis.svg)](https://badge.fury.io/rb/cache_store_redis)

Welcome to CacheStore!

This is the redis implementation for cache_store.

## Installation

Add this line to your application's Gemfile:

```ruby
gem 'cache_store_redis'
```

And then execute:

```bash
$ bundle
```

Or install it yourself as:

```bash
$ gem install cache_store_redis
```

## Testing

To run the tests locally, we use Docker to provide a Ruby container.

### Setup Images:

> This builds the Ruby docker image.

```bash
./script/setup.sh
```

### Run Tests:

> This executes the test suite

```bash
./script/test.sh
```

### Cleanup

> This is used to clean down docker images created in the setup script.

```bash
./script/cleanup.sh
```

## Development

After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb` and when release tag is created, Github Action pipeline will publish the `.gem` file to [rubygems.org](https://rubygems.org).

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/sage/cache_store_redis. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.

## License

Cache Store is available as open source under the terms of the
[MIT licence](LICENSE).

Copyright (c) 2018 Sage Group Plc. All rights reserved.