{"id":15115985,"url":"https://github.com/defnone/quickfeeds","last_synced_at":"2026-02-26T12:06:42.364Z","repository":{"id":243188492,"uuid":"811325432","full_name":"defnone/quickfeeds","owner":"defnone","description":"A simple self-hosted RSS reader with AI article summarization feature. 🧶☕️📜","archived":false,"fork":false,"pushed_at":"2025-08-01T14:38:57.000Z","size":7234,"stargazers_count":8,"open_issues_count":5,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-09-27T21:32:50.585Z","etag":null,"topics":["feed","flask-application","rss","rss-reader","self-hosted"],"latest_commit_sha":null,"homepage":"","language":"Python","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/defnone.png","metadata":{"files":{"readme":"README.md","changelog":"change_password.py","contributing":null,"funding":".github/FUNDING.yml","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},"funding":{"github":null,"patreon":"defnone","open_collective":null,"ko_fi":null,"tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"lfx_crowdfunding":null,"polar":null,"buy_me_a_coffee":null,"custom":null}},"created_at":"2024-06-06T11:33:02.000Z","updated_at":"2025-06-28T10:32:54.000Z","dependencies_parsed_at":null,"dependency_job_id":"bea6371d-ff4d-489e-ba4c-817b6c5e7ef2","html_url":"https://github.com/defnone/quickfeeds","commit_stats":null,"previous_names":["defnone/quickfeeds"],"tags_count":55,"template":false,"template_full_name":null,"purl":"pkg:github/defnone/quickfeeds","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/defnone%2Fquickfeeds","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/defnone%2Fquickfeeds/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/defnone%2Fquickfeeds/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/defnone%2Fquickfeeds/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/defnone","download_url":"https://codeload.github.com/defnone/quickfeeds/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/defnone%2Fquickfeeds/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29858462,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-26T08:51:08.701Z","status":"ssl_error","status_checked_at":"2026-02-26T08:50:19.607Z","response_time":89,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":["feed","flask-application","rss","rss-reader","self-hosted"],"created_at":"2024-09-26T01:44:06.834Z","updated_at":"2026-02-26T12:06:42.336Z","avatar_url":"https://github.com/defnone.png","language":"Python","funding_links":["https://patreon.com/defnone"],"categories":["Python"],"sub_categories":[],"readme":"# QuickFeeds [![Python application](https://github.com/defnone/quickfeeds/actions/workflows/python-app.yml/badge.svg)](https://github.com/defnone/quickfeeds/actions/workflows/python-app.yml)\nA simple self-hosted RSS reader with article summarization feature.\n\n*This is my first software project, developed for personal use.*\n\nThe application interface works well as a [Safari web app](https://support.apple.com/en-kw/guide/safari/ibrw9e991864/mac) for both macOS and iOS.\n\n![Screen](./assets/screenshot.png)\n\n\n\nTo activate summarization, you need to obtain a Groq API key and add it in the settings.\n\nAny article text is first summarized through Groq using the llama3 model, which is free within the limits for personal use. Currently, the summarization translation supports the following languages through Google Translate:\n\n- Russian: \"ru\"\n- English: \"en\"\n- German: \"de\"\n- French: \"fr\"\n- Spanish: \"es\"\n- Italian: \"it\"\n- Chinese: \"zh-CN\"\n- Japanese: \"ja\"\n- Korean: \"ko\"\n\nI'm not sure how well this works for most languages.\n\n## Getting Started\n\nTo get started with QuickFeeds, follow these steps to download the `docker-compose.yml` file and run the application.\n\n### Prerequisites\n\nEnsure you have Docker and Docker Compose installed on your machine. You can download and install them from the official Docker website: [Docker](https://www.docker.com/)\n\n### Installation\n\n#### Option 1: Using Docker Compose\n\n1. **Download the `docker-compose.yml` file**\n\n   Open your terminal and run the following command to download the `docker-compose.yml` file from the repository:\n\n   ```bash\n   curl -O https://raw.githubusercontent.com/defnone/quickfeeds/main/docker-compose.yml\n   ```\n\n2. **Run the application**\n\n   Once the `docker-compose.yml` file is downloaded, you can start the application with the following command:\n\n   ```bash\n   docker-compose up -d\n   ```\n\n   This command will start the application in detached mode, running it in the background.\n\n#### Option 2: Quick Launch Using Docker Run\n\nIf you prefer to quickly launch the application without using `docker-compose`, you can use the following `docker run` command:\n\n```bash\ndocker run -d \\\n  --name quickfeeds \\\n  -p 8000:8000 \\\n  -v quickfeeds_data:/data \\\n  -e FLASK_APP=run.py \\\n  -e FLASK_RUN_HOST=0.0.0.0 \\\n  -e FLASK_RUN_PORT=8000 \\\n  -e LOG_LEVEL=INFO \\\n  ghcr.io/defnone/quickfeeds:latest\n```\n\nNow you can access the interface at http://your-ip:8000 and create an account. Please ensure that the application is not accessible online for security reasons.\n\n### Updating the Application\n\nTo update the application to the latest version, follow these steps:\n\n1. **Pull the latest version of the Docker images**\n\n   Update the Docker images by pulling the latest version from the repository:\n\n   ```bash\n   docker-compose pull\n   ```\n\n2. **Recreate the containers**\n\n   After pulling the latest images, recreate the containers to apply the updates:\n\n   ```bash\n   docker-compose up -d --force-recreate\n   ```\n\n### Stopping the Application\n\nIf you need to stop the application, you can do so with the following command:\n\n```bash\ndocker-compose down\n```\n\nThis will stop and remove all the containers defined in the `docker-compose.yml` file.\n\n## Password Change\n\nThe password is stored encrypted in the database. To change it, you need to run the following command on the Docker host: \n```bash \ndocker exec quickfeeds-flask_app-1 python change_password.py user_name new_password\n```\nHere, `quickfeeds-flask_app-1` is the name of the container, which can be seen by running the command `docker ps`.\n\n## Runs on\n- Flask\n- SQLite\n- [Groq](https://github.com/groq/groq-python) API (for article summarization)\n- Google Translate (for translating summarized text)\n- [feedparser](https://github.com/kurtmckee/feedparser)\n- [feedfinder2](https://github.com/dfm/feedfinder2)\n- sumy\n\n\n## Acknowledgments\n\nSpecial thanks to OpenAI.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdefnone%2Fquickfeeds","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdefnone%2Fquickfeeds","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdefnone%2Fquickfeeds/lists"}