{"id":13495151,"url":"https://github.com/YannickFricke/FeedReader","last_synced_at":"2025-03-28T16:31:38.146Z","repository":{"id":54796925,"uuid":"158614991","full_name":"YannickFricke/FeedReader","owner":"YannickFricke","description":"A simple and beautiful electron app to read RSS and ATOM feeds","archived":true,"fork":false,"pushed_at":"2021-10-12T22:10:59.000Z","size":4355,"stargazers_count":4,"open_issues_count":14,"forks_count":1,"subscribers_count":2,"default_branch":"develop","last_synced_at":"2024-10-31T10:36:31.458Z","etag":null,"topics":["electron","react","rss-aggregator","rss-reader"],"latest_commit_sha":null,"homepage":null,"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/YannickFricke.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}},"created_at":"2018-11-21T22:48:27.000Z","updated_at":"2023-01-28T04:05:33.000Z","dependencies_parsed_at":"2022-08-14T03:10:30.239Z","dependency_job_id":null,"html_url":"https://github.com/YannickFricke/FeedReader","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/YannickFricke%2FFeedReader","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/YannickFricke%2FFeedReader/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/YannickFricke%2FFeedReader/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/YannickFricke%2FFeedReader/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/YannickFricke","download_url":"https://codeload.github.com/YannickFricke/FeedReader/tar.gz/refs/heads/develop","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246062830,"owners_count":20717696,"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":["electron","react","rss-aggregator","rss-reader"],"created_at":"2024-07-31T19:01:31.716Z","updated_at":"2025-03-28T16:31:37.653Z","avatar_url":"https://github.com/YannickFricke.png","language":"TypeScript","funding_links":[],"categories":["TypeScript"],"sub_categories":[],"readme":"# FeedReader [![Build Status](https://travis-ci.org/YannickFricke/FeedReader.svg?branch=develop)](https://travis-ci.org/YannickFricke/FeedReader) [![Coverage Status](https://coveralls.io/repos/github/YannickFricke/FeedReader/badge.svg?branch=develop)](https://coveralls.io/github/YannickFricke/FeedReader?branch=develop) [![Join the chat at https://gitter.im/RSS-ATOM-FeedReader/Lobby](https://badges.gitter.im/RSS-ATOM-FeedReader/Lobby.svg)](https://gitter.im/RSS-ATOM-FeedReader/Lobby) [![Greenkeeper badge](https://badges.greenkeeper.io/YannickFricke/FeedReader.svg)](https://greenkeeper.io/) \u003c!-- omit in toc --\u003e\n\nFeedReader is an electron application for reading RSS feeds in a beautiful GUI. It also supports ATOM feeds.\n\n- [Requirements](#requirements)\n- [Installation](#installation)\n- [Packaging](#packaging)\n  - [Package for Windows and Linux](#package-for-windows-and-linux)\n  - [Package for Mac OS](#package-for-mac-os)\n- [Contributing](#contributing)\n- [License](#license)\n- [Credits](#credits)\n\n## Requirements\n\n- A recent version of [Node.js](https://nodejs.org/)\n- A recent version of [Yarn](https://yarnpkg.com/)\n\n## Installation\n\nClone or download this repository.\n\nInstall all dependencies\n\n```shell\nyarn install\n```\n\nRun the \"start\" script with\n\n```shell\nyarn run start\n```\n\nThen an electron window should appear\n\n## Packaging\n\n### Package for Windows and Linux\n\nTo package this application you need to run the `build:prod` script first with:\n\n```shell\nyarn run build:prod\n```\n\nOtherwise electron-builder can't find the source script for the packaging process.\n\nThen run\n\n```shell\nyarn run package\n```\n\nto package the application for Windows and Linux. The Mac OS build is currently excluded from it.\n\n### Package for Mac OS\n\nWhen you want to package the application for Mac OS you need Mac OS and XCode for building it.\n\nThen run\n\n```shell\nyarn run electron-builder build -m\n```\n\nfor building for the Mac OS platform.\n\nCurrently we build for all three platforms with Travis-CI.\n\n## Contributing\n\nPull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.\n\nPlease make sure to update tests as appropriate.\n\nRun tests with the following command\n\n```shell\nyarn test\n```\n\n## License\n\n[MIT](https://choosealicense.com/licenses/mit/)\n\n## Credits\n\nIcon made by [Agata Kuczminska](https://www.flaticon.com/authors/agata-kuczminska) from [https://www.flaticon.com/](www.flaticon.com) which is licensed under [CC 3.0 BY](http://creativecommons.org/licenses/by/3.0/)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FYannickFricke%2FFeedReader","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FYannickFricke%2FFeedReader","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FYannickFricke%2FFeedReader/lists"}