https://github.com/kamil-kubiczek/caching-proxy
Simple caching proxy created in Node.js - CLI
https://github.com/kamil-kubiczek/caching-proxy
cache-proxy http nodejs proxy typescript
Last synced: 4 months ago
JSON representation
Simple caching proxy created in Node.js - CLI
- Host: GitHub
- URL: https://github.com/kamil-kubiczek/caching-proxy
- Owner: kamil-kubiczek
- Created: 2025-01-08T10:21:21.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2025-01-12T18:22:57.000Z (5 months ago)
- Last Synced: 2025-01-12T18:30:58.701Z (5 months ago)
- Topics: cache-proxy, http, nodejs, proxy, typescript
- Language: TypeScript
- Homepage:
- Size: 7.81 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
## About project
This is a simple implementation of an HTTP proxy that supports in-memory caching, with additional support for writing cache data to a file asynchronously in the background. This helps restore cache when proxy is run again. Proxy is designed to handle only GET requests, other HTTP methods aren't cached. Feel free to fork or inspire.
**Project status: 🟢Ready to use**
**Warning: 🟡Code has not been tested production**
## Features
Features provided by CLI and described here - https://roadmap.sh/projects/caching-server
## Installation
Install npm dependencies
```
npm i
```
## How to run proxy in CLI
**Prerequisites:**
- must have `node 20.x.x` installed
- must have `[email protected] or higher` installed
**Steps to run**
1. Inside project root directory run
```
npm run build
```
2. Then run
```
node dist/index.js -o -p
```
Now you can start using proxy!
## Help
If you need help with command options use `node dist/index.js -h`