mirror of https://github.com/TxtDot/txtdot.git synced 2024-10-04 06:06:03 +03:00

An HTTP proxy that only parses text, links and pictures from pages, thus using less bandwidth, removing ads and heavy scripts https://txt.dc09.ru

nodejs proxy readability

Find a file

Artemy Egorov 8c9fb3ee34 Merge pull request #228 from TxtDot/dependabot/npm_and_yarn/deps-078a8c0b77 Build(deps): Bump the deps group across 1 directory with 8 updates		2024-09-30 11:30:51 +03:00
.github	fix: update version	2024-08-06 23:28:29 +03:00
packages	Build(deps): Bump the deps group across 1 directory with 8 updates	2024-09-30 04:26:54 +00:00
.dockerignore	Dev (#207 )	2024-07-24 07:45:59 +00:00
.gitignore	refactor: create monorepo	2024-05-12 16:24:50 +03:00
.prettierignore	Dev (#207 )	2024-07-24 07:45:59 +00:00
.prettierrc	Timeout (#70 )	2023-12-13 21:08:24 +04:00
docker-compose.yml	fix(docker): change dist/.env volume path after restructuring project	2024-07-25 19:02:15 +04:00
Dockerfile	fix(docker): remove platform specifier	2024-08-05 20:54:15 +03:00
lerna.json	refactor: create monorepo	2024-05-12 16:24:50 +03:00
LICENSE	doc: fix licenses	2024-05-14 10:17:15 +03:00
package.json	Build(deps): Bump the deps group across 1 directory with 6 updates	2024-08-05 05:01:33 +00:00
pnpm-lock.yaml	Build(deps): Bump the deps group across 1 directory with 8 updates	2024-09-30 04:26:54 +00:00
pnpm-workspace.yaml	fix: lock and format	2024-05-12 16:28:25 +03:00
README.md	Dev (#207 )	2024-07-24 07:45:59 +00:00
SECURITY.md	doc: fix security.md	2024-07-26 11:30:26 +03:00

README.md

txtdot

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
Rendering client-side apps (Vanilla, React, Vue, etc) with webder
Search with SearXNG
Handy API endpoints
No client JavaScript
Some kind of Material Design 3
Customization with plugins, see @txtdot/sdk and @txtdot/plugins

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