https://github.com/caching-tools/next-shared-cache

Next.js self-hosting simplified
https://github.com/caching-tools/next-shared-cache

cache isr nextjs redis

Last synced: 4 days ago
JSON representation

Next.js self-hosting simplified

• Host: GitHub
• URL: https://github.com/caching-tools/next-shared-cache
• Owner: caching-tools
• License: mit
• Created: 2023-09-14T14:39:25.000Z (over 1 year ago)
• Default Branch: canary
• Last Pushed: 2024-10-28T20:09:57.000Z (about 2 months ago)
• Last Synced: 2024-10-29T15:49:20.986Z (about 2 months ago)
• Topics: cache, isr, nextjs, redis
• Language: TypeScript
• Homepage: https://caching-tools.github.io/next-shared-cache/
• Size: 4.72 MB
• Stars: 314
• Watchers: 2
• Forks: 21
• Open Issues: 24
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# `@neshca/cache-handler`

[![npm package](https://img.shields.io/npm/v/@neshca/cache-handler/latest.svg)](https://www.npmjs.com/package/@neshca/cache-handler)

[![Dependencies](https://img.shields.io/npm/dm/@neshca/cache-handler)](https://www.npmjs.com/package/@neshca/cache-handler)

[![License](https://img.shields.io/npm/l/express.svg)](https://github.com/caching-tools/next-shared-cache/blob/canary/packages/cache-handler/LICENSE)

Welcome to [`@neshca/cache-handler`](./packages/cache-handler/README.md) (pronounced [`/ˈnæʃkʌ/`](http://ipa-reader.xyz/?text=%CB%88n%C3%A6%CA%83k%CA%8C)), a specialized ISR/Data cache API crafted for Next.js applications. This library simplifies configuring shared cache strategies in distributed environments, such as multiple, independent application instances. It offers a flexible and easy-to-integrate solution for custom cache strategies, especially for Redis.

### Features

- **Shared Cache for Distributed Environments**: Perfect for self-hosted deployments with multiple application instances.

- **Easy Customization**: Provides a straightforward API with pre-configured Handlers.

- **On-Demand Revalidation**: Simplifies revalidation across all application replicas.

- **TTL Management**: Automatic cache cleanup to keep storage space efficient.

- **Support for Next.js Routers**: Full support and one setup for the Pages and the App Router.

- **`neshCache` Function**: Utilize the [`neshCache` ↗](https://caching-tools.github.io/next-shared-cache/functions/nesh-cache) function to replace `unstable_cache` for more control over caching.

- **`neshClassicCache` Function**: Use the CacheHandler in the Pages Router to cache the result of expensive operations in the `getServerSideProps` and API routes.

- **Pre-populate the Cache with Initial Data**: Automatically pre-populate the cache with the initial data when the application starts using the [instrumentation hook ↗](https://caching-tools.github.io/next-shared-cache/usage/populating-cache-on-start).

## Getting Started

Enhance your application's caching with our [Installation and First Steps Guide](https://caching-tools.github.io/next-shared-cache/installation). This guide covers installation, basic configuration, and practical examples for quick integration.

## Examples

Explore the versatility of `@neshca/cache-handler` in our [Examples Section](https://caching-tools.github.io/next-shared-cache/redis) with real-world scenarios. Learn how to build a custom Handler by following [this guide](https://caching-tools.github.io/next-shared-cache/usage/creating-a-custom-handler).

## Requirements

- **Next.js**: 13.5.1 or newer (below 15.0.0).

- **Node.js**: 18.17.0 or newer.

## Documentation

For detailed documentation, visit our [Documentation Page](https://caching-tools.github.io/next-shared-cache).

## Contributing

We welcome contributions! Check out our [Contributing Guide](./docs/contributing/monorepo.md) for more information.

## License

This project is licensed under the [MIT License](./LICENSE).