{"id":50483194,"url":"https://github.com/lebe-dev/deep-reader","last_synced_at":"2026-06-01T19:30:26.338Z","repository":{"id":361613934,"uuid":"1254940078","full_name":"lebe-dev/deep-reader","owner":"lebe-dev","description":null,"archived":false,"fork":false,"pushed_at":"2026-05-31T14:17:54.000Z","size":213,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-05-31T14:21:45.573Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Go","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/lebe-dev.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":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2026-05-31T07:28:51.000Z","updated_at":"2026-05-31T14:17:58.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/lebe-dev/deep-reader","commit_stats":null,"previous_names":["lebe-dev/deep-reader"],"tags_count":null,"template":false,"template_full_name":null,"purl":"pkg:github/lebe-dev/deep-reader","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lebe-dev%2Fdeep-reader","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lebe-dev%2Fdeep-reader/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lebe-dev%2Fdeep-reader/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lebe-dev%2Fdeep-reader/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/lebe-dev","download_url":"https://codeload.github.com/lebe-dev/deep-reader/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lebe-dev%2Fdeep-reader/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":33790617,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-01T02:00:06.963Z","response_time":115,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":[],"created_at":"2026-06-01T19:30:25.720Z","updated_at":"2026-06-01T19:30:26.333Z","avatar_url":"https://github.com/lebe-dev.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Deep Reader\n\nA self-hosted PWA for reading English-language articles with partial AI-assisted translation tuned to your CEFR proficiency level. Add an article URL, let the backend extract and enrich it via an OpenAI-compatible LLM, then read offline on any device — tap words and phrases to get in-context translations without a network connection.\n\n## Local development\n\nCopy the env template and fill in at minimum `AUTH_TOKEN`, `LLM_API_KEY`, and `LLM_API_BASE_URL`:\n\n```sh\ncp .env.example .env\n```\n\nRun the backend (Go, from the repo root):\n\n```sh\njust be-run\n```\n\nRun the SvelteKit dev server (separate terminal, with HMR):\n\n```sh\njust fe-dev\n```\n\nThe frontend dev server proxies API requests to the Go backend. The two servers run on different ports during development; for production they share a single origin because the frontend is embedded into the Go binary.\n\n## Production build\n\nBuild a single self-contained binary with the frontend embedded:\n\n```sh\njust build          # fe-build -\u003e embed -\u003e be-build\n./bin/deep-reader   # or: just be-run after setting env vars\n```\n\n`just build` runs `npm run build` in `frontend/`, copies the output into `web/dist/`, then compiles the Go binary. The `go:embed` directive in `web/web.go` bakes `web/dist/` into the binary at compile time, so no separate static-file directory is needed at runtime.\n\n## Deploy with Docker Compose\n\n```sh\ncp .env.example .env   # set AUTH_TOKEN, LLM_API_KEY, etc.\njust docker-build      # builds the multi-stage image\njust up                # docker compose up -d\njust logs              # tail logs\n```\n\nSQLite data is persisted in `./data/` on the host. The service binds only to `127.0.0.1:8080`; a reverse proxy (Caddy, nginx, Traefik) on the host must provide HTTPS — TLS is required for Service Workers and PWA installation to work on all browsers.\n\n## Content extraction\n\nArticle content is extracted before enrichment. By default Deep Reader uses [markdown.new](https://markdown.new) as the **primary** extractor: it converts a URL into clean Markdown that tokenizes and enriches better than raw HTML (and renders JS-heavy pages in a headless browser). The built-in readability extractor is the **fallback**, used automatically when markdown.new fails or when the daily budget is exhausted — so adding articles never hard-fails.\n\nThe free markdown.new plan grants **500 request units per day per IP**, resetting at UTC midnight. Deep Reader tracks consumption in SQLite and enforces a local budget so it can warn you before the service starts rejecting requests. With the default `MARKDOWN_COST_PER_ARTICLE=50` that is roughly **10 conversions/day**; once spent, extraction transparently falls back to readability until the next reset. The remaining daily budget is shown in the \"Add article\" dialog and returned by `GET /api/config` as `markdown_budget`.\n\n| Variable | Default | Purpose |\n|---|---|---|\n| `MARKDOWN_ENABLED` | `true` | Use markdown.new as the primary extractor. Set `false` to use readability only. |\n| `MARKDOWN_BASE_URL` | `https://markdown.new` | Service base URL (override for a self-hosted instance). |\n| `MARKDOWN_TIMEOUT` | `45s` | Timeout for a single conversion. |\n| `MARKDOWN_DAILY_LIMIT` | `500` | Request-unit budget per UTC day (`0` = unlimited). |\n| `MARKDOWN_COST_PER_ARTICLE` | `50` | Request units charged per article conversion. |\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flebe-dev%2Fdeep-reader","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flebe-dev%2Fdeep-reader","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flebe-dev%2Fdeep-reader/lists"}