ezerdemello / cache-manager

Cache module for Node.JS

Cache Manager

This is the cache manager mono repo that has the following packages:

• cache-manager - The core package that provides the cache manager library.
• cache-manager-redis-yet - The redis store for cache manager.
• cache-manager-ioredis-yet - The ioredis store for cache manager.

Getting Started

To get started you can visit the cache-manager package and learn how to use it. In addition here are some other documents:

• CODE_OF_CONDUCT.md - Our code of conduct
• CONTRIBUTING.md - How to contribute to this project

Store Engines

Official and updated to last version

• node-cache-manager-redis-yet (uses node_redis)
• node-cache-manager-ioredis-yet (uses ioredis)

Third party

• node-cache-manager-redis (uses sol-redis-pool)

• node-cache-manager-redis-store (uses node_redis)

• node-cache-manager-ioredis (uses ioredis)

• node-cache-manager-mongodb

• node-cache-manager-mongoose

• node-cache-manager-fs-binary

• node-cache-manager-fs-hash

• node-cache-manager-hazelcast

• node-cache-manager-memcached-store

• node-cache-manager-memory-store

• node-cache-manager-couchbase

• node-cache-manager-sqlite

• @resolid/cache-manager-sqlite (uses better-sqlite3)

Getting Started with the Mono Repo

Start by installing pnpm globally:

npm install -g pnpm

Then install the dependencies:

pnpm install

To run the tests:

pnpm test

To build the packages:

pnpm build

Open a Pull Request

You can contribute changes to this repo by opening a pull request:

1. After forking this repository to your Git account, make the proposed changes on your forked branch.
2. Run tests and linting locally.
   • Install and run Docker if you aren't already.
   • Run pnpm test:services:start, allow for the services to come up.
   • Run pnpm test.
3. Commit your changes and push them to your forked repository.
4. Navigate to the main cache-manager repository and select the Pull Requests tab.
5. Click the New pull request button, then select the option "Compare across forks"
6. Leave the base branch set to main. Set the compare branch to your forked branch, and open the pull request.
7. Once your pull request is created, ensure that all checks have passed and that your branch has no conflicts with the base branch. If there are any issues, resolve these changes in your local repository, and then commit and push them to git.
8. Similarly, respond to any reviewer comments or requests for changes by making edits to your local repository and pushing them to Git.
9. Once the pull request has been reviewed, those with write access to the branch will be able to merge your changes into the cache-manager repository.

If you need more information on the steps to create a pull request, you can find a detailed walkthrough in the Github documentation

Post an Issue

To post an issue, navigate to the "Issues" tab in the main repository, and then select "New Issue." Enter a clear title describing the issue, as well as a description containing additional relevant information. Also select the label that best describes your issue type. For a bug report, for example, create an issue with the label "bug." In the description field, Be sure to include replication steps, as well as any relevant error messages.

Please also refer to our Code of Conduct for more information on how to report issues.

Ask a Question

To ask a question, create an issue with the label "question." In the issue description, include the related code and any context that can help us answer your question.

License

MIT LISCENCE