hub / github.com/yang991178/fluent-reader

github.com/yang991178/fluent-reader @v1.2.2 sqlite

repository ↗ · DeepWiki ↗ · release v1.2.2 ↗

433 symbols 951 edges 77 files 0 documented · 0%

README

Fluent Reader

A modern desktop RSS reader

Download

For Windows 10 users, the recommended way of installation is through Microsoft Store. This enables auto-update and experimental ARM64 support. macOS users can also get Fluent Reader from the Mac App Store.

If you are using Linux or an older version of Windows, you can get Fluent Reader from GitHub releases.

Mobile App

The repo of the mobile version of this app can be found here.

Features

A modern UI inspired by Fluent Design System with full dark mode support.
Read locally or sync with self-hosted services compatible with Fever or Google Reader API.
Sync with RSS Services including Inoreader, Feedbin, The Old Reader, BazQux Reader, and more.
Importing or exporting OPML files, full application data backup & restoration.
Read the full content with the built-in article view or load webpages by default.
Search for articles with regular expressions or filter by read status.
Organize your subscriptions with folder-like groupings.
Single-key keyboard shortcuts.
Hide, mark as read, or star articles automatically as they arrive with regular expression rules.
Fetch articles in the background and send push notifications.

Support for other RSS services are under fundraising.

Development

Contribute

Help make Fluent Reader better by reporting bugs or opening feature requests through GitHub issues.

You can also help internationalize the app by providing translations into additional languages. Refer to the repo of react-intl-universal to get started on internationalization.

If you enjoy using this app, consider supporting its development by donating through GitHub Sponsors, Paypal, or Alipay.

Build from source

# Install dependencies
npm install

# Compile ts & dependencies
npm run build

# Start the application
npm run electron

# Generate certificate for signature
electron-builder create-self-signed-cert
# Package the app for Windows
npm run package-win

Developed with

License

BSD

Extension points exported contracts — how you extend this code

ServiceConfigs (Interface)

(no doc)

src/schema-types.ts

MenuTreeItemProps (Interface)

(no doc)

src/components/menu.tsx

initFeedsAction (Interface)

(no doc)

src/scripts/models/feed.ts

Window (Interface)

(no doc)

src/bridges/utils.ts

TouchBarTexts (Interface)

(no doc)

src/schema-types.ts

FlatButtonProps (Interface)

(no doc)

src/components/utils/FlatButton.tsx

initFeedAction (Interface)

(no doc)

src/scripts/models/feed.ts

Window (Interface)

(no doc)

src/bridges/settings.ts

Core symbols most depended-on inside this repo

saveSettings

called by 21

src/scripts/models/app.ts

src/scripts/models/services/miniflux.ts

markRead

called by 11

src/scripts/models/item.ts

updateSource

called by 10

src/scripts/models/source.ts

createSourceGroup

called by 8

src/scripts/models/group.ts

markAllRead

called by 8

src/scripts/models/item.ts

fetchAPI

called by 8

src/scripts/models/services/feedbin.ts

Shape

Function 253

Interface 68

Class 50

Method 46

Enum 16

Languages

TypeScript100%

Modules by API surface

src/scripts/models/app.ts42 symbols

src/scripts/models/source.ts34 symbols

src/scripts/models/item.ts28 symbols

src/scripts/models/group.ts26 symbols

src/scripts/models/page.ts25 symbols

src/scripts/models/feed.ts25 symbols

src/scripts/utils.ts18 symbols

src/scripts/models/service.ts17 symbols

src/schema-types.ts12 symbols

src/components/context-menu.tsx11 symbols

src/scripts/models/rule.ts9 symbols

src/scripts/models/services/miniflux.ts8 symbols

Dependencies from manifests, versioned

@fluentui/react7.126.2 · 1×

@fluentui/react-components9.73.7 · 1×

@fluentui/react-migration-v8-v99.10.9 · 1×

@fluentui/react-shared-contexts9.26.2 · 1×

@griffel/react1.6.1 · 1×

@griffel/webpack-plugin4.0.1 · 1×

@types/lovefield2.1.3 · 1×

@types/nedb1.8.9 · 1×

@types/react16.9.35 · 1×

@types/react-dom16.9.8 · 1×

@types/react-redux7.1.9 · 1×

css-loader7.1.4 · 1×

For agents

$ claude mcp add fluent-reader \
  -- python -m otcore.mcp_server <graph>

⬇ download graph artifact