txtdot

mirror of https://github.com/txtdot/txtdot synced 2024-10-18 14:40:19 +03:00

Go to file

Artemy Egorov 7c72d985f7 Merge pull request from GHSA-4gj5-xj97-j8fp * ci: add build check to pull requests * Build(deps-dev): Bump @types/node from 20.10.6 to 20.11.24 (#91) Bumps [@types/node](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/HEAD/types/node) from 20.10.6 to 20.11.24. - [Release notes](https://github.com/DefinitelyTyped/DefinitelyTyped/releases) - [Commits](https://github.com/DefinitelyTyped/DefinitelyTyped/commits/HEAD/types/node) --- updated-dependencies: - dependency-name: "@types/node" dependency-type: direct:development update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * feat: image compression (#101) * feat: image compression * fix: not compress svg Maybe we should add a function to disable this fix. Since I noticed that if you compress svg in webp it becomes magically smaller. * Configuration page (#104) * feat: image compression * feat: configuration page * refactor: json stringify and change engine buttons to ordered list * fix: engine distributor matching * fix: formatting * build: update txtdot version to 1.7.0 * fix: configuration page title * doc: features (#102) * fix: ssrf GHSA-4gj5-xj97-j8fp Doesn't fully correct the error! You need to configure the server to block requests. --------- Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>		2024-03-07 14:49:54 +03:00
.github	Merge pull request from GHSA-4gj5-xj97-j8fp	2024-03-07 14:49:54 +03:00
config	Refactor: config folder for init and nginx.conf	2023-08-31 17:37:50 +04:00
src	Merge pull request from GHSA-4gj5-xj97-j8fp	2024-03-07 14:49:54 +03:00
static	Merge pull request from GHSA-4gj5-xj97-j8fp	2024-03-07 14:49:54 +03:00
templates	Merge pull request from GHSA-4gj5-xj97-j8fp	2024-03-07 14:49:54 +03:00
.dockerignore	Update .dockerignore	2023-08-27 12:41:35 +03:00
.env.example	Merge pull request from GHSA-4gj5-xj97-j8fp	2024-03-07 14:49:54 +03:00
.eslintrc.json	Timeout (#70 )	2023-12-13 21:08:24 +04:00
.gitattributes	Initial commit	2023-08-13 20:38:33 +03:00
.gitignore	Initial commit	2023-08-13 20:38:33 +03:00
.prettierrc	Timeout (#70 )	2023-12-13 21:08:24 +04:00
docker-compose.yml	Timeout (#70 )	2023-12-13 21:08:24 +04:00
Dockerfile	fix: all docker issues	2023-08-28 22:15:13 +03:00
LICENSE	Create LICENSE	2023-08-14 14:39:36 +03:00
package-lock.json	Merge pull request from GHSA-4gj5-xj97-j8fp	2024-03-07 14:49:54 +03:00
package.json	Merge pull request from GHSA-4gj5-xj97-j8fp	2024-03-07 14:49:54 +03:00
README.md	Merge pull request from GHSA-4gj5-xj97-j8fp	2024-03-07 14:49:54 +03:00
tsconfig.json	Mass refactoring and stackoverflow users parser (#83 )	2024-02-25 18:17:56 +00:00

README.md

HTTP proxy that parses only text, links and pictures from pages reducing internet traffic, removing ads and heavy scripts. Mozilla's Readability library is used under the hood.

Features

Server-side page simplification
Media proxy
Image compression with Sharp
Search with SearXNG
Custom parsers for StackOverflow and SearXNG
Handy API endpoints
No client JavaScript
Some kind of Material Design 3

Running

Development

npm install
npm run dev

Production

npm install
npm run build
npm run start

Docker

docker compose up -d

Screenshots

Performance tests

txtdot is a great tool in case of slow internet connection or weak signal. Here is the comparision of performance metrics from pagespeed.web.dev between original page and proxied one.

"Mobile" test includes "Slow 4G" artificial network throttling.

Expand