https://github.com/snc/SncRedisBundle

A Redis bundle for Symfony supporting Predis and PhpRedis
https://github.com/snc/SncRedisBundle

bundle php phpredis predis redis symfony symfony-bundle

Last synced: 3 months ago
JSON representation

A Redis bundle for Symfony supporting Predis and PhpRedis

• Host: GitHub
• URL: https://github.com/snc/SncRedisBundle
• Owner: snc
• License: mit
• Created: 2010-07-08T21:11:04.000Z (over 14 years ago)
• Default Branch: master
• Last Pushed: 2024-09-12T07:45:20.000Z (4 months ago)
• Last Synced: 2024-10-29T14:53:54.512Z (3 months ago)
• Topics: bundle, php, phpredis, predis, redis, symfony, symfony-bundle
• Language: PHP
• Homepage: https://github.com/snc/SncRedisBundle
• Size: 1.13 MB
• Stars: 1,039
• Watchers: 36
• Forks: 328
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# RedisBundle #

[![Latest Stable Version](https://poser.pugx.org/snc/redis-bundle/v/stable?format=flat-square)](https://packagist.org/packages/snc/redis-bundle)

[![License](https://poser.pugx.org/snc/redis-bundle/license?format=flat-square)](https://packagist.org/packages/snc/redis-bundle)

[![Monthly Downloads](https://poser.pugx.org/snc/redis-bundle/d/monthly?format=flat-square)](https://packagist.org/packages/snc/redis-bundle)

[![Build Status](https://github.com/snc/SncRedisBundle/actions/workflows/continuous-integration.yml/badge.svg)](https://github.com/snc/SncRedisBundle/actions)

## About ##

This bundle integrates [Predis](https://github.com/nrk/predis) and [PhpRedis](https://github.com/phpredis/phpredis) into your Symfony 4.4+ application,

providing a fast and convenient interface to [Redis](https://redis.io/).

Using the native PhpRedis extension is recommended as it is faster and our main development platform. If the extension is not available and cannot

be installed in your environment Predis is considered a safe and portable alternative, and our integration should be functionally identical.

## Installation ##

Use [Composer](https://github.com/composer/composer):

```sh

composer require snc/redis-bundle

```

## Documentation ##

[Read the documentation in docs/](docs/)

## Contributing

Running full test suite requires PHP installed with certain PHP extensions and redis server, 

as well as [overmind](https://github.com/DarthSim/overmind) to start the fleet of redis processes.

Because of this, we use [Nix](https://nixos.org/) for local development. 

After you [install Nix](https://github.com/DeterminateSystems/nix-installer), make sure you are in directory with SncRedisBundle.

Within it, you can run

```

nix shell

```

to install and enter the development environment. Once there, you can run

```

composer update # install php package dependencies

overmind start & # start redis fleet

php vendor/bin/phpunit # run tests, or anything else you want with php binary

```

## License ##

See [LICENSE](LICENSE).