https://github.com/martenframework/marten-redis-cache

A Redis cache store for the Marten web framework.
https://github.com/martenframework/marten-redis-cache

cache crystal framework marten redis web

Last synced: 19 days ago
JSON representation

A Redis cache store for the Marten web framework.

• Host: GitHub
• URL: https://github.com/martenframework/marten-redis-cache
• Owner: martenframework
• License: mit
• Created: 2023-04-16T17:45:27.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-07-11T21:31:37.000Z (6 months ago)
• Last Synced: 2024-07-12T00:15:15.291Z (6 months ago)
• Topics: cache, crystal, framework, marten, redis, web
• Language: Crystal
• Homepage:
• Size: 27.3 KB
• Stars: 4
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Marten Redis Cache

[![CI](https://github.com/martenframework/marten-redis-cache/workflows/Specs/badge.svg)](https://github.com/martenframework/marten-redis-cache/actions)

[![CI](https://github.com/martenframework/marten-redis-cache/workflows/QA/badge.svg)](https://github.com/martenframework/marten-redis-cache/actions)

**Marten Redis Cache** provides a [Redis](https://redis.io) cache store that can be used with Marten web framework's [cache system](https://martenframework.com/docs/caching).

## Installation

Simply add the following entry to your project's `shard.yml`:

```yaml

dependencies:

  marten_redis_cache:

    github: martenframework/marten-redis-cache

```

And run `shards install` afterward.

## Configuration

First, add the following requirement to your project's `src/project.cr` file:

```crystal

require "marten_redis_cache"

```

Then you can configure your project to use the Redis cache store by setting the corresponding configuration option as follows:

```crystal

Marten.configure do |config|

  config.cache_store = MartenRedisCache::Store.new(uri: "redis:///")

end

```

The `uri` argument is optional: unless specified, the client will attempt to connect to Redis on `localhost` and port `6379`. It should be noted that this cache store also supports all the existing initialization options in addition to the `uri` argument (eg. `namespace`, `version`, `expires_in`, etc). Please refer to the [cache system documentation](https://martenframework.com/docs/caching) to learn more about Marten's caching framework.

## Authors

Morgan Aubert ([@ellmetha](https://github.com/ellmetha)) and 

[contributors](https://github.com/martenframework/marten-redis-cache/contributors).

## License

MIT. See ``LICENSE`` for more details.