https://github.com/garyeung/caching_server_cli
This is a simple caching proxy server. it forwards requests to the actual server and cache the responses. If the same request is made again, it returns the cached response instead of forwarding the request to the server.
https://github.com/garyeung/caching_server_cli
caching-proxy cli redis-cache typescript
Last synced: 2 months ago
JSON representation
This is a simple caching proxy server. it forwards requests to the actual server and cache the responses. If the same request is made again, it returns the cached response instead of forwarding the request to the server.
- Host: GitHub
- URL: https://github.com/garyeung/caching_server_cli
- Owner: garyeung
- License: mit
- Created: 2024-11-14T12:46:43.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-11-20T01:35:00.000Z (over 1 year ago)
- Last Synced: 2025-05-13T17:36:54.171Z (about 1 year ago)
- Topics: caching-proxy, cli, redis-cache, typescript
- Language: TypeScript
- Homepage: https://roadmap.sh/projects/caching-server
- Size: 8.79 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# caching_server
(https://roadmap.sh/projects/caching-server)
This is a simple caching proxy server. it forwards requests to the actual server and cache the responses. If the same request is made again, it returns the cached response instead of forwarding the request to the server.
## Prerequisites
- Node.js (v14 or higher)
- npm or yarn
- Redis
## Installation
```sh
git clone https://github.com/garyeung/caching_server_CLI.git
cd caching_server_CLI
npm install
```
After connecting your own Redis database, creating your .env file according to the .env.example file
## Usage
```sh
npm run build
npm run exec -- -h # help
npm run exec -- -p -o ## port and origin
npm run exec -- -c ## clean cache
```
## Project Structure
```
/project
/src
cli: gets port, origin and clean-cache order
checks if the port is the legal port or not
server: runs the proxy server on the specified port and pass the origin url to the proxy middleware
cache: functions clean cache, get cache and save cache in Redis
proxyMiddleware: responses if has cache otherwise requests to origin and saves cache