{"id":26749146,"url":"https://github.com/TempoWorks/txtdot","last_synced_at":"2025-03-28T11:03:31.189Z","repository":{"id":188266150,"uuid":"678105101","full_name":"TempoWorks/txtdot","owner":"TempoWorks","description":"An HTTP proxy that parses only text, links and pictures from pages reducing internet bandwidth usage, removing ads and heavy scripts","archived":false,"fork":false,"pushed_at":"2025-03-22T20:09:03.000Z","size":1232,"stargazers_count":174,"open_issues_count":10,"forks_count":7,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-03-22T21:19:03.039Z","etag":null,"topics":["minify","nodejs","proxy","readability","self-hosted","text"],"latest_commit_sha":null,"homepage":"https://txt.dc09.ru","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/TempoWorks.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-08-13T17:38:48.000Z","updated_at":"2025-03-22T20:09:07.000Z","dependencies_parsed_at":"2023-11-17T19:53:28.498Z","dependency_job_id":"0fd6a0a9-98c4-4b8d-a211-2d2f54196318","html_url":"https://github.com/TempoWorks/txtdot","commit_stats":null,"previous_names":["txtdot/txtdot","tempoworks/txtdot"],"tags_count":19,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TempoWorks%2Ftxtdot","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TempoWorks%2Ftxtdot/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TempoWorks%2Ftxtdot/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TempoWorks%2Ftxtdot/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/TempoWorks","download_url":"https://codeload.github.com/TempoWorks/txtdot/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246017729,"owners_count":20710240,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["minify","nodejs","proxy","readability","self-hosted","text"],"created_at":"2025-03-28T11:02:04.850Z","updated_at":"2025-03-28T11:03:31.183Z","avatar_url":"https://github.com/TempoWorks.png","language":"TypeScript","funding_links":[],"categories":["TypeScript"],"sub_categories":[],"readme":"\u003e [!WARNING]\n\u003e The project is frozen for a while. txtdot needs a complete rewrite in rust and dalet integration, which is not finished yet.\n\n\u003cdiv align=\"center\"\u003e\n\n![txtdot logo](https://github.com/TempoWorks/.github/raw/main/imgs/txtdot.png)\n\n\u003ca href=\"https://tempoworks.github.io/documentation\"\u003e\u003cimg alt=\"Documentation\" src=\"https://img.shields.io/badge/Documentation-blue\"\u003e\u003c/a\u003e\n\u003ca href=\"https://github.com/tempoworks/instances\"\u003e\u003cimg alt=\"Instances\" src=\"https://img.shields.io/badge/Instances-blue\"\u003e\u003c/a\u003e\n\u003cbr\u003e\n\u003ca href=\"https://github.com/tempoworks/txtdot/blob/main/LICENSE\"\u003e\u003cimg alt=\"MIT license\" src=\"https://img.shields.io/github/license/tempoworks/txtdot?color=blue\"\u003e\u003c/a\u003e\n\u003ca href=\"https://github.com/tempoworks/txtdot/releases/latest\"\u003e\u003cimg alt=\"Latest release\" src=\"https://img.shields.io/github/v/release/tempoworks/txtdot?display_name=release\"\u003e\u003c/a\u003e\n\n# txtdot\n\n\u003c/div\u003e\n\nHTTP proxy that parses only text, links and pictures from pages\nreducing internet traffic, removing ads and heavy scripts.\nMozilla's Readability library is used under the hood.\n\n## Features\n\n- Server-side page simplification\n- Media proxy\n- Image compression with Sharp\n- Rendering client-side apps (Vanilla, React, Vue, etc) with [webder](https://github.com/tempoworks/webder)\n- Search with SearXNG\n- Handy API endpoints\n- No client JavaScript\n- Some kind of Material Design 3\n- Customization with plugins, see [@txtdot/sdk](https://github.com/tempoworks/txtdot/tree/main/packages/sdk) and [@txtdot/plugins](https://github.com/tempoworks/txtdot/tree/main/packages/plugins)\n\n## Running\n\n### Development\n\n```bash\nnpm install\nnpm run dev\n```\n\n### Production\n\n```bash\nnpm install\nnpm run build\nnpm run start\n```\n\n### Docker\n\n```bash\ndocker compose up -d\n```\n\n## Screenshots\n\n\u003cdiv align=\"center\"\u003e\n\u003cimg src=\"https://raw.githubusercontent.com/tempoworks/.github/main/imgs/ui_url_input.png\" alt=\"Main page with URL input field\"\u003e\n\u003cimg src=\"https://raw.githubusercontent.com/tempoworks/.github/main/imgs/ui_search_page.png\" alt=\"SearXNG search results page\"\u003e\n\u003c/div\u003e\n\n## Performance tests\n\ntxtdot is a great tool in case of slow internet connection or weak signal.\nHere is the comparision of performance metrics from pagespeed.web.dev\nbetween original page and proxied one.\n\n\"Mobile\" test includes \"Slow 4G\" artificial network throttling.\n\n\u003cdetails\u003e\n\u003csummary\u003eExpand\u003c/summary\u003e\n\n|                                  |     Original page     | Proxied through txtdot |\n| :------------------------------- | :-------------------: | :--------------------: |\n| [Habr][habr-link] Desktop        |  ![56%][habr-do-img]  |  ![99%][habr-dt-img]   |\n| [Habr][habr-link] Mobile         |  ![21%][habr-mo-img]  |  ![100%][habr-mt-img]  |\n| [Medium][medium-link] Desktop    | ![44%][medium-do-img] | ![100%][medium-dt-img] |\n| [Medium][medium-link] Mobile     | ![36%][medium-mo-img] | ![100%][medium-mt-img] |\n| [Nginx Blog][nginx-link] Desktop | ![53%][nginx-do-img]  | ![100%][nginx-dt-img]  |\n| [Nginx Blog][nginx-link] Mobile  | ![26%][nginx-mo-img]  | ![100%][nginx-mt-img]  |\n\n[habr-link]: https://habr.com/ru/articles/780692/\n[habr-do-img]: https://raw.githubusercontent.com/tempoworks/.github/main/tests/habr/desktop_orig.png\n[habr-dt-img]: https://raw.githubusercontent.com/tempoworks/.github/main/tests/habr/desktop_txtdot.png\n[habr-mo-img]: https://raw.githubusercontent.com/tempoworks/.github/main/tests/habr/mobile_orig.png\n[habr-mt-img]: https://raw.githubusercontent.com/tempoworks/.github/main/tests/habr/mobile_txtdot.png\n[medium-link]: https://levelup.gitconnected.com/proxy-servers-how-proxies-work-0ec083fc1030\n[medium-do-img]: https://raw.githubusercontent.com/tempoworks/.github/main/tests/medium/desktop_orig.png\n[medium-dt-img]: https://raw.githubusercontent.com/tempoworks/.github/main/tests/medium/desktop_txtdot.png\n[medium-mo-img]: https://raw.githubusercontent.com/tempoworks/.github/main/tests/medium/mobile_orig.png\n[medium-mt-img]: https://raw.githubusercontent.com/tempoworks/.github/main/tests/medium/mobile_txtdot.png\n[nginx-link]: https://www.nginx.com/blog/rate-limiting-nginx/\n[nginx-do-img]: https://raw.githubusercontent.com/tempoworks/.github/main/tests/nginx-blog/desktop_orig.png\n[nginx-dt-img]: https://raw.githubusercontent.com/tempoworks/.github/main/tests/nginx-blog/desktop_txtdot.png\n[nginx-mo-img]: https://raw.githubusercontent.com/tempoworks/.github/main/tests/nginx-blog/mobile_orig.png\n[nginx-mt-img]: https://raw.githubusercontent.com/tempoworks/.github/main/tests/nginx-blog/mobile_txtdot.png\n\n\u003c/details\u003e\n\n## Credits\n\n- [Readability.js](https://github.com/mozilla/readability)\n- [🔗 LinkeDOM](https://github.com/WebReflection/linkedom)\n- [Fastify web framework](https://github.com/fastify/fastify)\n- [EJS](https://github.com/mde/ejs)\n- [Axios](https://github.com/axios/axios)\n- [DOMPurify](https://github.com/cure53/DOMPurify)\n- [Sharp](https://github.com/lovell/sharp)\n- [MicroMatch](https://github.com/micromatch/micromatch)\n- [RouteParser](https://github.com/rcs/route-parser)\n- [IconvLite](https://github.com/ashtuchkin/iconv-lite)\n\n\u003ca href=\"https://www.producthunt.com/posts/txtdot?utm_source=badge-featured\u0026utm_medium=badge\u0026utm_souce=badge-txtdot\" target=\"_blank\"\u003e\u003cimg src=\"https://api.producthunt.com/widgets/embed-image/v1/featured.svg?post_id=443317\u0026theme=neutral\" alt=\"txtdot - HTTP\u0026#0032;proxy\u0026#0032;that\u0026#0032;saves\u0026#0032;bandwidth\u0026#0044;\u0026#0032;removing\u0026#0032;ads\u0026#0032;and\u0026#0032;scripts\u0026#0046; | Product Hunt\" style=\"width: 250px; height: 54px;\" width=\"250\" height=\"54\" /\u003e\u003c/a\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FTempoWorks%2Ftxtdot","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FTempoWorks%2Ftxtdot","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FTempoWorks%2Ftxtdot/lists"}