https://github.com/adonisjs/redis
Package for working with Redis in AdonisJS
https://github.com/adonisjs/redis
first-party-package ioredis redis
Last synced: 5 months ago
JSON representation
Package for working with Redis in AdonisJS
- Host: GitHub
- URL: https://github.com/adonisjs/redis
- Owner: adonisjs
- License: mit
- Created: 2016-07-04T13:41:07.000Z (over 9 years ago)
- Default Branch: 9.x
- Last Pushed: 2025-02-07T08:36:36.000Z (8 months ago)
- Last Synced: 2025-05-15T04:18:37.115Z (5 months ago)
- Topics: first-party-package, ioredis, redis
- Language: TypeScript
- Homepage:
- Size: 906 KB
- Stars: 75
- Watchers: 8
- Forks: 20
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# @adonisjs/redis
[![gh-workflow-image]][gh-workflow-url] [![npm-image]][npm-url] ![][typescript-image] [![license-image]][license-url]
## Introduction
Redis provider for AdonisJS with support for multiple Redis connections, cluster, pub/sub and much more
## Official Documentation
The documentation is available on the [AdonisJS website](https://docs.adonisjs.com/guides/database/redis)
## Contributing
One of the primary goals of AdonisJS is to have a vibrant community of users and contributors who believes in the principles of the framework.
We encourage you to read the [contribution guide](https://github.com/adonisjs/.github/blob/main/docs/CONTRIBUTING.md) before contributing to the framework.
### Run tests locally
Easiest way to run tests is to launch the redis cluster using `docker compose` and `compose.yml` file.
```sh
docker compose up
npm run test
```
We also have a `compose.ci.yml` file that will dockerize the library and run tests inside the container. This is what we use on Github actions.
## Code of Conduct
In order to ensure that the AdonisJS community is welcoming to all, please review and abide by the [Code of Conduct](https://github.com/adonisjs/.github/blob/main/docs/CODE_OF_CONDUCT.md).
## License
AdonisJS Redis is open-sourced software licensed under the [MIT license](LICENSE.md).
[gh-workflow-image]: https://img.shields.io/github/actions/workflow/status/adonisjs/redis/checks.yml?branch=9.x&style=for-the-badge
[gh-workflow-url]: https://github.com/adonisjs/redis/actions/workflows/checks.yml "Github action"
[npm-image]: https://img.shields.io/npm/v/@adonisjs/redis/latest.svg?style=for-the-badge&logo=npm
[npm-url]: https://www.npmjs.com/package/@adonisjs/redis/v/latest "npm"
[typescript-image]: https://img.shields.io/badge/Typescript-294E80.svg?style=for-the-badge&logo=typescript
[license-url]: LICENSE.md
[license-image]: https://img.shields.io/github/license/adonisjs/redis?style=for-the-badge