GitHub - svr-js/svrjs-cache-mod: A simple in-memory cache mod for SVR.JS that works with "Cache-Control" and "Vary" headers (mirror of https://git.svrjs.org/svrjs/svrjs-cache-mod).

This repository was archived by the owner on Mar 25, 2025. It is now read-only.

svr-js / svrjs-cache-mod Public archive

Notifications You must be signed in to change notification settings
Fork 0
Star 0

A simple in-memory cache mod for SVR.JS that works with "Cache-Control" and "Vary" headers (mirror of https://git.svrjs.org/svrjs/svrjs-cache-mod).

MIT license

0 stars 0 forks Branches Tags Activity

Star

Notifications

Branches Tags

Name		Name	Last commit message	Last commit date
Latest commit History 14 Commits
.github/workflows		.github/workflows
.husky		.husky
src		src
tests		tests
.gitignore		.gitignore
LICENSE		LICENSE
README		README
commitlint.config.js		commitlint.config.js
esbuild.config.js		esbuild.config.js
eslint.config.js		eslint.config.js
jest.config.js		jest.config.js
lint-staged.config.js		lint-staged.config.js
modInfo.json		modInfo.json
package-lock.json		package-lock.json
package.json		package.json
prettier.config.js		prettier.config.js

Repository files navigation

This repository contains SVR.JS mod starter code and its build system
The mod will work for SVR.JS Nightly-GitNext.

Before doing anything, run "npm install".
To build SVR.JS mod, run "npm run build".
To check SVR.JS mod code for errors with ESLint, run "npm run lint".
To fix and beautify SVR.JS mod code with ESLint and Prettier, run "npm run lint:fix".
To perform unit tests with Jest, run "npm test".

To test the mod:
1. Clone the SVR.JS repository with "git clone https://git.svrjs.org/svrjs/svrjs.git" command.
2. Change the working directory to "svrjs" using "cd svrjs".
3. Build SVR.JS by first running "npm install" and then running "npm run build".
4. Copy the mod into mods directory in the dist directory using "cp ../dist/mod.js dist/mods" (GNU/Linux, Unix, BSD) or "copy ..\dist\mod.js dist\mods" (Windows).
5. Do the necessary mod configuration if the mod requires it.
6. Run SVR.JS by running "npm start".
7. Do some requests to the endpoints covered by the mod.

Structure:
 - dist - contains the built SVR.JS mod
 - src - contains SVR.JS mod source code
   - index.js - entry point
   - utils - utility functions
 - tests - Jest unit tests
   - utils - unit tests for utility functions
 - esbuild.config.js - the build script
 - eslint.config.js - ESLint configuration
 - jest.config.js - Jest configuration
 - modInfo.json - SVR.JS mod name and version