Git Product home page Git Product logo

irodr's Introduction

Irodr Actions Status: test

RSS reader client for Inoreader.

This RSS reader provide a similar experience to LDR.

Screen Shot

Purpose

  • Fast read RSS like LDR
    • Prefetch contents
    • Mark as "read" on idle time
  • Keyboard Shortcut
  • Customizable by UserScript

Usage

login gif

  1. Open https://irodr.netlify.app/
  2. Click Connect to Inoreader
  3. Click Authorize on Inoreader site

Keyboard Shortcut

  • j: move-next-content-item
  • shift+j: load-more-past-contents
  • t: toggle-content-filter
  • k: move-prev-content-item
  • a: move-prev-subscription-feed
  • s: move-next-subscription-feed
  • m: make-subscription-read
  • v: open-current-content-url
  • z: toggle-subscription-feed-list
  • space: scroll-down-content
  • shift+space: scroll-up-content
  • shift+s: skip-and-move-next-subscription-feed

Custom Client Id and Client Secret

If you want to your Client ID/Secret of inoreader, do following steps:

  1. Visit https://www.inoreader.com/
  2. Open "Preferences"
  3. Open "Developer" tab
  4. Create new App
    • "Redirect URL" is not required
    • "Scoped": Read and Write
  5. Copy Client Id and Client Secret

Create new App

You paste the Client ID and secret to Irodr Authorization.

Irodr Authorization

UserScript API

Irodr provide some UserScript API for UserScript like Greasemonkey.

  • window.addEventListener("userscript-init", (event) => { /* Initialize UseScript object */ })
  • window.userScript.getActiveContent(): UserScriptActiveContent | undefined
  • window.userScript.getActiveSubscription(): UserScriptActiveSubscription | undefined
  • window.userScript.triggerKey(keys: string, action?: string): void

For more details, see UserScript API document. See also resources/userScript directory.

๐Ÿ“ Notes

Development

Usage

Run following command and open local server.

npm start
# open http://localhost:13245/

๐Ÿ“ CORS workaround

Inoreader doesn't support CORS for API. So, Irodr use CORS proxy for Inoreader API.

Production

http://irodr.netlify.app/ work on Netlify. It uses Netlify Edge Functions for CORS proxy.

Recommend: You can connect to Inoreader API without CORS proxy via UserScripts.

Also, you can use own CORS proxy.

Local server

In local, you can just run npm run dev and open http://localhost:8888/.

npm run dev

๐Ÿ“ Limitation of Mixed-content

A browser show a warning on https://irodr.netlify.app/ It is caused by Mixed content.

Changelog

See Releases page.

Running tests

Install devDependencies and Run npm test:

npm test

Code of Conduct

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

Contributing

Pull requests and stars are always welcome.

For bugs and feature requests, please create an issue.

  1. Fork it!
  2. Create your feature branch: git checkout -b my-new-feature
  3. Commit your changes: git commit -am 'Add some feature'
  4. Push to the branch: git push origin my-new-feature
  5. Submit a pull request :D

Author

License

MIT ยฉ azu

OSS Supports

Netlify

irodr's People

Contributors

azu avatar renovate-bot avatar renovate[bot] avatar yayugu avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar

irodr's Issues

Filter duplicated contents

Some feed has duplicate contents.
For example, hatena bookmark may have same contents in the feed.
Because hatena bookmark user book the same contents as difference url.

  • original url
  • ifttt url , short url

Unread and Next

We want to get the feature that unread and next.
If focus any feed, we can leave from there without mark read.

Not working on gh-pages

We have added deploy script that work on Travis CI.
But, gh-page has been white page.
Because %PUBLIC_URL% is not replaced. Why?

and we should replace auth url

Subscriptions on root isn't shown.

I found Irodr only shown subscriptions which contained by some folders.
It seems a bug or unkind behavior.

ใ™ใฐใ‚‰ใ—ใ„ใƒ—ใƒญใƒ€ใ‚ฏใƒˆใ‚’ใ‚ใ‚ŠใŒใจใ†ใ”ใ–ใ„ใพใ™
ๆ„Ÿๅ‹•ใ—ใชใŒใ‚‰ไฝฟใ„ๅง‹ใ‚ใฆใ„ใพใ™๏ผ:heart:


Edit by @azu

Summary:
Irodr had a bug that disappear Uncategorized feeds.
Currently, this bug was fixed

Statistics

We want to get statistics menu.

  • read count
  • request count

?ci mode

We want to CI mode for this webpage.

It will useful for performance testings/E2E testing #12

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.