{"id":27127859,"url":"https://github.com/jacob-shuman/readl8r","last_synced_at":"2025-04-07T17:58:06.838Z","repository":{"id":255772808,"uuid":"848458935","full_name":"jacob-shuman/readl8r","owner":"jacob-shuman","description":"A no-nonsense read later service","archived":false,"fork":false,"pushed_at":"2024-10-21T02:13:54.000Z","size":2241,"stargazers_count":22,"open_issues_count":5,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-10-21T05:32:28.932Z","etag":null,"topics":["atom","docker","docker-compose","foss","json-feed","read-later","rss","self-hosted","sveltekit"],"latest_commit_sha":null,"homepage":"","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/jacob-shuman.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}},"created_at":"2024-08-27T19:51:02.000Z","updated_at":"2024-10-21T02:13:57.000Z","dependencies_parsed_at":"2024-10-22T05:16:48.734Z","dependency_job_id":null,"html_url":"https://github.com/jacob-shuman/readl8r","commit_stats":null,"previous_names":["jacob-shuman/readl8r"],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jacob-shuman%2Freadl8r","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jacob-shuman%2Freadl8r/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jacob-shuman%2Freadl8r/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jacob-shuman%2Freadl8r/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jacob-shuman","download_url":"https://codeload.github.com/jacob-shuman/readl8r/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247704499,"owners_count":20982293,"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":["atom","docker","docker-compose","foss","json-feed","read-later","rss","self-hosted","sveltekit"],"created_at":"2025-04-07T17:58:06.072Z","updated_at":"2025-04-07T17:58:06.827Z","avatar_url":"https://github.com/jacob-shuman.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cpicture\u003e\n\t\u003csource media=\"(prefers-color-scheme: dark)\" srcset=\"./static/favicon-dark.svg\" /\u003e\n\t\u003cimg alt=\"logo\" src=\"./static/favicon-light.svg\" width=\"128px\" /\u003e\n\u003c/picture\u003e\n\n# readl8r\n\n\u003e A no-nonsense read later service\n\n\u003ca href=\"https://kit.svelte.dev/\"\u003e\n\t\u003cpicture\u003e\n\t\t\u003csource media=\"(prefers-color-scheme: dark)\" srcset=\"https://img.shields.io/badge/sveltekit-202020?style=for-the-badge\u0026logo=svelte\" /\u003e\n\t\t\u003cimg alt=\"svelte badge\" src=\"https://img.shields.io/badge/sveltekit-f0f0f0?style=for-the-badge\u0026logo=svelte\" /\u003e\n\t\u003c/picture\u003e\n\u003c/a\u003e\n\u003ca href=\"https://tailwindcss.com/\"\u003e\n\t\u003cpicture\u003e\n\t\t\u003csource media=\"(prefers-color-scheme: dark)\" srcset=\"https://img.shields.io/badge/tailwindcss-202020?style=for-the-badge\u0026logo=tailwindcss\" /\u003e\n\t\t\u003cimg alt=\"tailwindcss badge\" src=\"https://img.shields.io/badge/tailwindcss-f0f0f0?style=for-the-badge\u0026logo=tailwindcss\" /\u003e\n\t\u003c/picture\u003e\n\u003c/a\u003e\n\u003ca href=\"https://hub.docker.com/r/jacobshuman/readl8r\"\u003e\n\t\u003cpicture\u003e\n\t\t\u003csource media=\"(prefers-color-scheme: dark)\" srcset=\"https://img.shields.io/badge/docker-202020?style=for-the-badge\u0026logo=docker\" /\u003e\n\t\t\u003cimg alt=\"docker badge\" src=\"https://img.shields.io/badge/docker-f0f0f0?style=for-the-badge\u0026logo=docker\" /\u003e\n\t\u003c/picture\u003e\n\u003c/a\u003e\n\n## :star: Features\n\n- :heavy_plus_sign: [Add an article](#heavy_plus_sign-add-an-article) by making a `POST` request (with `url` in a `JSON` body) to `/articles/add`.\n- :clipboard: [Get a `JSON` array of all articles](#clipboard-get-a-json-array-of-all-articles) by making a `GET` request to `/articles`.\n- :wastebasket: [Remove all articles](#wastebasket-remove-all-articles) by making a `DELETE` request to `/articles/clear`.\n- :file_cabinet: All articles are stored in a `/data/local.sqlite` SQLite database.\n- :inbox_tray: Get an [RSS](https://www.rssboard.org/rss-specification), [Atom](https://validator.w3.org/feed/docs/atom.html), and [JSON](https://www.jsonfeed.org/) feed of articles at [`/rss`](#inbox_tray-generate-rss2-feed-from-articles), [`/atom`](#inbox_tray-generate-atom-feed-from-articles), and [`/json`](#inbox_tray-generate-json-feed-from-articles) respectively.\n\n\u003cpicture\u003e\n\t\u003csource media=\"(prefers-color-scheme: dark)\" srcset=\"./screenshots/home-dark.jpeg\" /\u003e\n\t\u003cimg alt=\"home page screenshot\" src=\"./screenshots/home-light.jpeg\"  /\u003e\n\u003c/picture\u003e\n\n## :rocket: Getting started\n\n### :ship: Docker Compose\n\nAlthough you can clone/build readl8r locally, it's recommended for users to run the [docker image on Docker Hub](https://hub.docker.com/r/jacobshuman/readl8r). Copy the contents of this [docker-compose.yml](./docker-compose.yml) file to your computer and run:\n\n```bash\ndocker compose up\n```\n\n### :palm_tree: Environment variables\n\n| Name               | Required             | Description                                                                    | Default     |\n| ------------------ | -------------------- | ------------------------------------------------------------------------------ | ----------- |\n| `AUTH_SECRET`      | If `PASSWORD` is set | Used to sign auth JWTs                                                         | `undefined` |\n| `HOST`             | No                   | Hostname or IP address where the service is hosted                             | `0.0.0.0`   |\n| `PORT`             | No                   | The port number used for the service                                           | `80`        |\n| `SECURE`           | No                   | Indicates whether to use HTTPS (true) or HTTP (false)                          | `false`     |\n| `PASSWORD`         | No                   | Password required for authentication                                           | `undefined` |\n| `FEED_TITLE`       | No                   | Title of the feed (displayed on the web app)                                   | `undefined` |\n| `FEED_DESCRIPTION` | No                   | Brief description of the feed's content and purpose (displayed on the web app) | `undefined` |\n| `FEED_IMAGE`       | No                   | URL to an image that represents the feed (e.g., logo or banner)                | `undefined` |\n| `FEED_FAVICON`     | No                   | URL to the favicon to be displayed in browsers for the feed                    | `undefined` |\n| `FEED_COPYRIGHT`   | No                   | Copyright information regarding the content of the feed                        | `undefined` |\n| `AUTHOR_NAME`      | No                   | Name of the feed's author                                                      | `undefined` |\n| `AUTHOR_EMAIL`     | No                   | Email address of the author                                                    | `undefined` |\n| `AUTHOR_LINK`      | No                   | URL to the author's website or social media profile                            | `undefined` |\n\n### :lock: Authentication\n\nYou can **optionally** protect your reading list with a password by setting the `PASSWORD` and `AUTH_SECRET` environment variables in your docker compose config.\n\nThis will protect all routes excluding feed routes (`/rss`, `/atom`, etc).\n\nI'm still looking into how rss aggregators generally handle auth for feeds and only want to add auth when it doesn't prevent aggregators from accessing reading lists.\n\n## Stucture of an article\n\n```ts\n{\n\tid: number;\n\turl: string;\n\tpublish_date: string; // date article was published (added_date if this can't be found)\n\tadded_date: string; // date the article was added to readl8r\n\ttitle: string | null;\n\tdescription: string | null;\n\tcontent: string | null;\n\tauthor: string | null;\n\tfavicon: string | null;\n\tttr: number | null; // estimated time to read article in seconds\n}\n```\n\n\u003e For the most up to date definition, see [the actual typescript type](./src/lib/types.ts#L16).\n\n## :heavy_plus_sign: Add an article\n\n:lock: **Requires Authentication**\n\nYou can add an article by providing the article's url in the body of a `POST` request:\n\n`POST (http|https)://HOST:PORT/articles/add`\n\n### :weight_lifting: body\n\n```jsonc\n{\n\t// required\n\t\"url\": \"https://dev.to/jacobshuman/wtf-is-a-github-profile-readmemd-1p8c\"\n}\n```\n\n\u003c!-- ```jsonc\n{\n\t// required\n\t\"url\": \"https://dev.to/jacobshuman/wtf-is-a-github-profile-readmemd-1p8c\",\n\n\t// optional\n\t\"title\": \"WTF is a GitHub Profile README.md\",\n\t\"description\": \"What is a profile README and why would I want one?\",\n\t\"author\": \"Jacob Shuman\",\n\t\"content\": \"\",\n\t\"date\": \"\"\n}\n``` --\u003e\n\n### Responses\n\n| Status | Body                                  | Content-Type |\n| ------ | ------------------------------------- | ------------ |\n| 200    | `article added successfully`          | `text/plain` |\n| 400    | `url is required`                     | `text/plain` |\n| 400    | `unable to extract metadata at {url}` | `text/plain` |\n| 401    | `not authorized`                      | `text/plain` |\n\n## :page_facing_up: Get a single `JSON` article\n\n:lock: **Requires Authentication**\n\nYou can get a single `JSON` object representing an article by making a `GET` request to the `/articles/:id` route:\n\n`GET (http|https)://HOST:PORT/articles/:id`\n\n### Responses\n\n| Status | Body                                      | Content-Type       |\n| ------ | ----------------------------------------- | ------------------ |\n| 200    | [Article](./src/lib/types.ts#L16)         | `application/json` |\n| 401    | `not authorized`                          | `text/plain`       |\n| 404    | `there is no article with an id of \":id\"` | `text/plain`       |\n\n## :clipboard: Get a `JSON` array of all articles\n\n:lock: **Requires Authentication**\n\nYou can get a `JSON` array of articles by making a `GET` request to the `/articles` route:\n\n`GET (http|https)://HOST:PORT/articles`\n\n### Responses\n\n| Status | Body                                | Content-Type       |\n| ------ | ----------------------------------- | ------------------ |\n| 200    | [Article[]](./src/lib/types.ts#L16) | `application/json` |\n| 401    | `not authorized`                    | `text/plain`       |\n\n## :memo: Update an article\n\n:lock: **Requires Authentication**\n\nYou can update an article based on it's id by making a `PATCH` request to the `/articles/:id/update` route:\n\n`PATCH (http|https)://HOST:PORT/articles/:id/update`\n\n### :weight_lifting: body\n\n```jsonc\n{\n\t\"article\": {\n\t\t\"url\": \"\", // optional\n\t\t\"publish_date\": \"\", // optional\n\t\t\"added_date\": \"\", // optional\n\t\t\"title\": \"\", // optional\n\t\t\"description\": \"\", // optional\n\t\t\"content\": \"\", // optional\n\t\t\"author\": \"\", // optional\n\t\t\"favicon\": \"\", // optional\n\t\t\"ttr\": \"\" // optional\n\t}\n}\n```\n\n### Responses\n\n| Status | Body                                 | Content-Type |\n| ------ | ------------------------------------ | ------------ |\n| 200    | `article :id deleted successfully`   | `text/plain` |\n| 401    | `not authorized`                     | `text/plain` |\n| 404    | `there is no article with id of :id` | `text/plain` |\n\n## :wastebasket: Delete an article\n\n:lock: **Requires Authentication**\n\nYou can delete an article based on it's id by making a `DELETE` request to the `/articles/:id/delete` route:\n\n`DELETE (http|https)://HOST:PORT/articles/:id/delete`\n\n### Responses\n\n| Status | Body                                 | Content-Type |\n| ------ | ------------------------------------ | ------------ |\n| 200    | `article :id deleted successfully`   | `text/plain` |\n| 401    | `not authorized`                     | `text/plain` |\n| 404    | `there is no article with id of :id` | `text/plain` |\n\n## :wastebasket: Remove all articles\n\n:lock: **Requires Authentication**\n\n`DELETE (http|https)://HOST:PORT/articles/clear`\n\n### Responses\n\n| Status | Body                              | Content-Type |\n| ------ | --------------------------------- | ------------ |\n| 200    | `x articles cleared successfully` | `text/plain` |\n| 401    | `not authorized`                  | `text/plain` |\n\n## :wastebasket: Purge old articles\n\n:lock: **Requires Authentication**\n\nYou can manually purge articles older than a certain threshhold using the `/articles/purge` route. Simply pass an `older_than` query parameter in the url with the following format:\n\n```\nh = hours\nd = days\nm = months\ny = years\n\n\u003cinteger\u003eh|d|m|y\n\nExamples\n\n30d = 30 days\n4m  = 4 months\n2y  = 2 years\n```\n\n\u003e Please note the `older_than` parameter does **not** accept numbers with decimals.\n\n`DELETE (http|https)://HOST:PORT/articles/purge?older_than=\u003cnumber\u003e(h|d|m|y)`\n\n### Responses\n\n| Status | Body                                                           | Content-Type |\n| ------ | -------------------------------------------------------------- | ------------ |\n| 200    | `x articles purged successfully`                               | `text/plain` |\n| 400    | `invalid format, use the formula \"\u003cnumber\u003e\u003ch \\| d \\| m \\| y\u003e\"` | `text/plain` |\n| 401    | `not authorized`                                               | `text/plain` |\n\n## :inbox_tray: Generate RSS2 feed from articles\n\n`GET (http|https)://HOST:PORT/rss`\n\n`GET (http|https)://HOST:PORT/rss.xml`\n\n`GET (http|https)://HOST:PORT/feed`\n\n`GET (http|https)://HOST:PORT/feed.xml`\n\n### Responses\n\n| Status | Body                                                    | Content-Type          |\n| ------ | ------------------------------------------------------- | --------------------- |\n| 200    | [RSS2 Feed](https://www.rssboard.org/rss-specification) | `application/rss+xml` |\n\n## :inbox_tray: Generate Atom feed from articles\n\n`GET (http|https)://HOST:PORT/atom`\n\n### Responses\n\n| Status | Body                                                      | Content-Type           |\n| ------ | --------------------------------------------------------- | ---------------------- |\n| 200    | [Atom Feed](https://validator.w3.org/feed/docs/atom.html) | `application/atom+xml` |\n\n## :inbox_tray: Generate JSON feed from articles\n\n`GET (http|https)://HOST:PORT/json`\n\n### Responses\n\n| Status | Body                                   | Content-Type       |\n| ------ | -------------------------------------- | ------------------ |\n| 200    | [JSON Feed](https://www.jsonfeed.org/) | `application/json` |\n\n## :heart: Health\n\nA simple `GET` route to see if the server is up and ready to handle incoming requests.\n\n`GET (http|https)://HOST:PORT/health`\n\n### Responses\n\n| Status | Body | Content-Type |\n| ------ | ---- | ------------ |\n| 200    | `OK` | `text/plain` |\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjacob-shuman%2Freadl8r","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjacob-shuman%2Freadl8r","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjacob-shuman%2Freadl8r/lists"}