https://github.com/osmoscraft/osmosfeed Skip to content Sign up Sign up * Why GitHub? Features - + Mobile - + Actions - + Codespaces - + Packages - + Security - + Code review - + Project management - + Integrations - + GitHub Sponsors - + Customer stories- * Team * Enterprise * Explore + Explore GitHub - Learn and contribute + Topics - + Collections - + Trending - + Learning Lab - + Open source guides - Connect with others + The ReadME Project - + Events - + Community forum - + GitHub Education - + GitHub Stars program - * Marketplace * Pricing Plans - + Compare plans - + Contact Sales - + Education - [ ] [search-key] * # In this repository All GitHub | Jump to | * No suggested jump to results * # In this repository All GitHub | Jump to | * # In this organization All GitHub | Jump to | * # In this repository All GitHub | Jump to | Sign in Sign up Sign up {{ message }} osmoscraft / osmosfeed * Notifications * Star 32 * Fork 0 A web-based RSS reader running entirely from your GitHub repo. osmoscraft.org MIT License 32 stars 0 forks Star Notifications * Code * Issues 0 * Pull requests 0 * Actions * Projects 0 * Wiki * Security * Insights More * Code * Issues * Pull requests * Actions * Projects * Wiki * Security * Insights master Switch branches/tags [ ] Branches Tags Nothing to show {{ refName }} default View all branches Nothing to show {{ refName }} default View all tags 1 branch 0 tags Go to file Code Clone HTTPS GitHub CLI [https://github.com/o] Use Git or checkout with SVN using the web URL. [gh repo clone osmosc] Work fast with our official CLI. Learn more. * Open with GitHub Desktop * Download ZIP Launching GitHub Desktop If nothing happens, download GitHub Desktop and try again. Go back Launching GitHub Desktop If nothing happens, download GitHub Desktop and try again. Go back Launching Xcode If nothing happens, download Xcode and try again. Go back Launching Visual Studio If nothing happens, download the GitHub extension for Visual Studio and try again. Go back Latest commit @chuanqisun chuanqisun Update README.md ... 4863870 Apr 30, 2021 Update README.md 4863870 Git stats * 134 commits Files Permalink Failed to load latest commit information. Type Name Latest commit message Commit time .vscode update docs Apr 11, 2021 docs fix dev guide Apr 12, 2021 scripts rss 1.0 and robust timestamp parsing Apr 11, 2021 src fixed blurry icon Apr 20, 2021 .gitignore portable build for any repo Nov 15, 2020 .prettierrc basic styling Nov 15, 2020 CHANGELOG.md fixed blurry icon Apr 20, 2021 LICENSE Update license Apr 11, 2021 README.md Update README.md Apr 30, 2021 dev-log.org rename to dev log Dec 29, 2020 osmosfeed.yaml update test feed Apr 13, 2021 package-lock.json 1.2.3 Apr 20, 2021 package.json 1.2.3 Apr 20, 2021 tsconfig.json prepare for open source Apr 11, 2021 View code osmos::feed Demo Get started Create a repository Turn on GitHub Pages Customize the feed Next steps Contributions FAQ Can I update the content more frequently? Can I make the site private so only I can see it? Do I have to type index.html at the end of the URL? How to trigger a manual site update? How to build the site without using cache? Ecosystem README.md image osmos::feed A web-based RSS reader running entirely from your GitHub repo. * The feed is statically hosted as GitHub Pages. The content stays the same until the next build. * The feed is rebuilt periodically by GitHub Actions, configured in .github/workflows/update-feed.yaml. * During a rebuild, cache from the previous build is used, so only new content will be downloaded. * The source of the content can be any RSS feed URL, configured in osmosfeed.yaml. * The content fetching and static site generation is powered by a custom node.js script optimized for speed. Demo image * Open demo | View source Get started Create a repository 1. Open Create a new repository from osmosfeed-template. 2. Set visibility to "Public". 3. Click "Create repository from template" button. Turn on GitHub Pages 1. In the repository you just created, navigate to Settings tab > Pages section. 2. In Source option, select gh-pages, click "Save" button. If gh-pages doesn't exist, wait for a couple of seconds and refresh the page. It will eventually show up. image 3. Refresh the page until it shows Your site is published at https:/ /GITHUB_USERNAME.github.io/REPO_NAME. This may take up to a minute. image Customize the feed 1. In the repository root, open osmosfeed.yaml file, click the "Pencil (Edit this file)" button to edit. 2. Remove # to uncommend the cacheUrl property, replace GITHUB_USERNAME with your GitHub username, and replace REPO_NAME with your GitHub username. 3. In the sources, update the items to the sources you want to follow. The final content of the file should look similar to this: cacheUrl: https://REPLACED_GITHUB_USERNAME.github.io/REPLACED_REPO_NAME/cache.json sources: - href: https://my-rss-source-1/feed/ - href: https://my-rss-source-2/rss/ - href: https://my-rss-source-3/feed - href: https://my-rss-source-4/news/rss - href: https://my-rss-source-5/rss/ 4. Scroll to the bottom of the page, click "Commit changes" button. 5. Once the rebuild finishes, your feed will be available at https:/ /REPLACED_GITHUB_USERNAME.github.io/REPLACED_REPO_NAME. Next steps * Read the developer guide * (coming soon) How to customize refresh schedule * (coming soon) How to deploy to other hosts Contributions My current focus is to bring the entire osmos::craft project online. Until then, I have no bandwidth for new feature requests or PRs. However, issues and bug reports are always welcome. I'll keep track of issues and address them once I have more time. Thank your for being patient. FAQ Can I update the content more frequently? Yes, you can make it as frequent as you want. But be aware that there is a limit to the free tier of GitHub Actions. My rough estimate shows that even with hourly update, you should still have planty of unused time everyone. You can monitory spending on Billing & plans page in Account settings. Can I make the site private so only I can see it? It is not possible with GitHub Pages. However, if you move the site to a different hosting service, you should be able to set up authorization on the host level. For example, if you deploy to Netlify, there is a paid plan for password protection. Do I have to type index.html at the end of the URL? No. But there is a known issue with GitHub. See discussion from GitHub Community and some solutions from Stack Overflow How to trigger a manual site update? You can make some changes to the osmosfeed.yaml file to trigger an update. For example, add an empty comment like this # on a new line. How to build the site without using cache? You can comment out the cacheUrl property in the osmosfeed.yaml. Note that after the build, cache will still be created, except it won't contain any content from the previous cache. Ecosystem osmos::feed is part of the osmos::craft ecosystem. If you enjoy this tool, you might also like: * osmos::memo: An in-browser bookmark manager optimized for tagging and retrieval speed. * osmos::note: A web-based text editor for networked note-taking, self-hostable on any Git repository. About A web-based RSS reader running entirely from your GitHub repo. osmoscraft.org Topics rss rss-reader self-hosted feed reader github-actions Resources Readme License MIT License Used by 3 * @realwuliao @realwuliao / -osmos123 * @osmoscraft @osmoscraft / osmosfeed-template * @chuanqisun @chuanqisun / daily-read Languages * TypeScript 73.6% * CSS 11.9% * JavaScript 11.9% * HTML 2.6% * (c) 2021 GitHub, Inc. * Terms * Privacy * Security * Status * Docs * Contact GitHub * Pricing * API * Training * Blog * About You can't perform that action at this time. You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.