Skip to content
frostcubePublic

About

A simple RSS reader made with TypeScript, Angular and Ionic

Topics

Resources

Contributing

Stars

8 stars

Watchers

1 watching

Forks

Latest commit

 

History

50 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Just RSS

Just RSS was created so that people would have a RSS client that could run on their smart phone. Designed for people with less than 50 feeds but still want to use RSS without self hosting or a subscription (You can add more feeds, it may just be slow depending on your phone).

Core pillars:

  • Open Source (Yah!)
  • All processing done on-device
  • No Ads
  • No Subscription
  • Distraction free

The intention is to keep Just RSS a simple app with as few features as possible, however the open source nature means that you are able to fork it and add your dream feature if that's what you want and that's cool too.

Beta Access

Google PlayTestflight

Just RSS Feed Page

Developer Getting Started

Requires Node.js 20.x or 22.x (Angular 18).

npm install -g @ionic/cli native-run cordova-res
npm install -g @angular/cli
npm install

npm install also runs patch-package (see patches/) to apply a small fix to @stencil/core that removes an upstream build warning.

Scripts

Command Description
npm start Serve the app locally (ng serve)
npm run build Production build into www/
npm run lint Lint src/ with ESLint (npm run lint:fix to auto-fix)
npm test Run unit tests in Chrome in watch mode
npm run test:ci Run unit tests once in headless Chrome

Lint, tests and the build run in CI on every push and pull request to main (.github/workflows/node.js.yml). The build is expected to finish with no errors or warnings.

Testing

Unit tests use Jasmine and Karma and live next to the code as *.spec.ts files. Chrome must be installed (set CHROME_BIN if it is not on the default path). Specs that touch storage use the in-memory FakeStorage and provideTestingStorage() from src/testing/storage-mock.ts, so no SQLite or IndexedDB is needed.

Building

Web

The local proxy currently re-writes address such as https://www.theverge.com/ and makes them available with debugging CORS headers and then remaps them to local address. For instance the verge is available here: http://localhost:8100/verge

Command to run with proxy enabled for debugging:

ionic serve -- --proxy-config proxy.conf.json

RSS local feeds:

http://localhost:8100/polygon/feed/
http://localhost:8100/verge/rss/index.xml

Android and iOS

To rebuild assets (icon and splash screen) run:

npx capacitor-assets generate

For naming details see the relevant Capacitor Guide

Sync web bundle (www) to platform:

ionic cap copy

Changes to native plugins:

ionic cap sync

Android

Open project in Android Studio:

ionic cap open android

iOS

Open project in XCode:

ionic cap open ios

RSS Feed Samples

https://derme.coffee/index.xml
https://news.ycombinator.com/rss
https://www.polygon.com/feed/
https://www.theverge.com/rss/index.xml
https://feeds.megaphone.fm/vergecast

About

A simple RSS reader made with TypeScript, Angular and Ionic

Topics

Resources

Contributing

Stars

8 stars

Watchers

1 watching

Forks

Releases

Packages

Used by

Contributors

Languages