Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/luispittagros/nuxt-ssr-redis-cache
:rocket: Blazing Fast Nuxt Server Side Rendering using Redis.
https://github.com/luispittagros/nuxt-ssr-redis-cache
cache fast improvement nuxt nuxtjs page performance redis redis-cache ssr vue vuejs
Last synced: about 1 month ago
JSON representation
:rocket: Blazing Fast Nuxt Server Side Rendering using Redis.
- Host: GitHub
- URL: https://github.com/luispittagros/nuxt-ssr-redis-cache
- Owner: luispittagros
- Created: 2022-05-07T17:50:40.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2023-05-24T00:48:40.000Z (over 1 year ago)
- Last Synced: 2024-04-24T01:22:23.355Z (5 months ago)
- Topics: cache, fast, improvement, nuxt, nuxtjs, page, performance, redis, redis-cache, ssr, vue, vuejs
- Language: JavaScript
- Homepage:
- Size: 17.6 KB
- Stars: 11
- Watchers: 1
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-blazingly-fast - nuxt-ssr-redis-cache - :rocket: Blazing Fast Nuxt Server Side Rendering using Redis. (JavaScript)
README
Nuxt SSR Redis Cache
:rocket: Blazing Fast Nuxt Server Side Rendering using Redis.
:heart: Boost your NuxtJS application's performance with ease and efficiency
## Setup
To install the `nuxt-ssr-redis-cache` module in your project, use the following:
```
npm install @luispittagros/nuxt-ssr-redis-cache --save
```
## Configuration
You can configure `nuxt-ssr-redis-cache` in your `nuxt.config.js` file:
```js
modules: [
[
'@luispittagros/nuxt-ssr-redis-cache',
{
enabled: true,
client: {
socket: {
host: '127.0.0.1',
port: 6379,
},
password: null,
},
paths: [/^\/$/, '/articles/'], // If empty or "/" is set, all pages will be cached
ttl: 60 * 60, // 1 hour
cacheCleanEndpoint: {
enabled: false,
path: '/ssr-redis-cache',
cors: '*',
},
}
]
],
```
Alternatively, you can set it up as follows:
```js
modules: ['@luispittagros/nuxt-ssr-redis-cache'],
ssrRedisCache: {
enabled: true,
client: {
socket: {
host: '127.0.0.1',
port: 6379,
},
password: null,
},
paths: [/^\/$/, '/articles/'], // If empty or "/", is set all pages will be cached
ttl: 60 * 60, // 1 hour
cacheCleanEndpoint: {
enabled: true,
path: '/ssr-redis-cache',
cors: '*',
}
},
```
### Redis Client Configuration
For the client configuration, please refer to the comprehensive guide provided by `node-redis`. You can find this reference [here](https://github.com/redis/node-redis/blob/master/docs/client-configuration.md).
### Cache Clean Endpoint
We provide an endpoint to clear cached paths. This is especially useful if your content changes frequently and needs to be updated on a regular basis.
To utilize this endpoint, send a POST request to your Nuxt application. The default path for this request is `/ssr-redis-cache`. Your request should include the following JSON request body:
```json
{
"paths" : [ "/", "/example/" ]
}
```
If you need to clear all cached pages, use "*" as your path.
For setting up Cross-Origin Resource Sharing (CORS) options, kindly refer to the express cors middleware options. You can access these options [here](https://expressjs.com/en/resources/middleware/cors.html).
### Understanding Cached Pages
A page is considered 'cacheable' or 'cached' if it has the HTTP response header "X-Cache". This header can carry either "HIT" or "MISS" value, indicating whether the requested data was retrieved from the cache or not.