-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
9 additions
and
11 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,35 +1,33 @@ | ||
# Bandwidth Hero Data Compression Service | ||
|
||
[![NSP Status](https://nodesecurity.io/orgs/bandwidth-hero/projects/1f035cf0-00f2-43db-9bc0-8e39adb24642/badge)](https://nodesecurity.io/orgs/bandwidth-hero/projects/1f035cf0-00f2-43db-9bc0-8e39adb24642) | ||
This is a fork NOT primarily for adding new features. It just keeps it updated, and for minor changes. | ||
|
||
This data compression service is used by | ||
[![CodeFactor](https://www.codefactor.io/repository/github/adityagupta150/bandwidth-hero-proxy/badge)](https://www.codefactor.io/repository/github/adityagupta150/bandwidth-hero-proxy) | ||
|
||
The original and this fork, both are, data compression service used by | ||
[Bandwidth Hero](https://github.com/ayastreb/bandwidth-hero) browser extension. It compresses given | ||
image to low-res [WebP](https://developers.google.com/speed/webp/) or JPEG image. Optionally it also | ||
converts image to greyscale to save even more data. | ||
|
||
It downloads original image and transforms it with [Sharp](https://github.com/lovell/sharp) on the | ||
fly without saving images on disk. | ||
|
||
This is **NOT** an anonymizing proxy — it downloads images on user's behalf, passing cookies | ||
This is **NOT** an anonymizing proxy -- it downloads images on user's behalf, passing cookies | ||
and user's IP address through to the origin host. | ||
|
||
## Deployment | ||
|
||
### Heroku | ||
|
||
You can deploy this service to Heroku: | ||
|
||
[![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy?template=https://github.com/ayastreb/bandwidth-hero-proxy) | ||
|
||
[![Deploy to Heroku guide](http://img.youtube.com/vi/y3tkYEXAics/0.jpg)](http://www.youtube.com/watch?v=y3tkYEXAics) | ||
[![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy?template=https://github.com/AdityaGupta150/bandwidth-hero-proxy) | ||
|
||
<!-- READ THIS ARTICLE LATER AdityaG | ||
### Self-hosted | ||
|
||
Data compression service is a Node.js app which you can run on any server that supports Node.js. | ||
Check out | ||
[this guide](https://www.digitalocean.com/community/tutorials/how-to-set-up-a-node-js-application-for-production-on-ubuntu-16-04) | ||
on how to setup Node.js on Ubuntu. | ||
|
||
on how to setup Node.js on Ubuntu. | ||
DigitalOcean also provides an | ||
[easy way](https://www.digitalocean.com/products/one-click-apps/node-js/) to setup a server ready to | ||
host Node.js apps. | ||
--> |