RSS reader client like LDR for Inoreader.
Switch branches/tags
Nothing to show
Clone or download
azu fix(netlify): use https
Netlify force to use https at 2018-09-12
Latest commit f488c3f Sep 12, 2018

README.md

Irodr Build Status

RSS reader client for Inoreader.

It aim to work on browser/electron.

screenshot

Purpose

  • Fast read
    • Prefetch contents
    • Mark as "read" at idle time
  • Customizable by UserScript
    • We will provide some API like window.getActiveItem for UserScript.
  • Allow of other RSS reader API like Feedly
    • Domain model should not depended on Inoreader
  • Welcome to Pull Request!

Usage

  1. Open http://irodr.netlify.com/
  2. Redirect to Inoreader auth page
  3. Authorize if you want to use inoreader
  4. Load your feed!

Custom OAuth Client Id/Client Secret

If you want to your Client ID/Secret, 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.

πŸ“ Notes

Development

Usage

Run following command and open local server.

npm start
open http://localhost:13245/

πŸ“ CORS workaround

Production

http://irodr.netlify.com/ work on Netlify. Netlify support CORS proxy

Local server

This project use the server that avoid CORS for Inoreader.

npm start

Browser extension

πŸ“ Mixed-content

http://irodr.netlify.com/ is also https://irodr.netlify.com/ But, https can not embed http content by mixed-content rule.

Perf

Run pwmetrics.

npm run pwmerics

Changelog

See Releases page.

Running tests

Install devDependencies and Run npm test:

npm i -d && npm test

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