Project Goals #1

New Issue

danieljsummers · 2024-04-04T01:30:39Z

danieljsummers commented

2024-04-04 01:30:39 +00:00

This software will allow one or multiple users to subscribe to RSS feeds and read the articles from those feeds. Below, items starting with [A] will be done before the first alpha release, and items starting with [R] will be completed (or deferred) before the software goes beta. After a testing period, v1 will be released.

Users

[A] There will be a single-user / no-password mode, where any user hitting the site is assumed to be the only user. (#3)
[R] There will also be modes where that single user can provide a password, and modes that support multiple users with passwords. (#9)

Feeds

[A] An authorized user will have the ability to add feeds by URL. (#4)
[R] A feed may also be added by providing a site's URL, and the software will extract the feed from the provided HTML. (#10)
[A] Feeds will be refreshed on-demand (#5), [R] or on a configurable schedule (#11).

Items

[A] The items in an RSS feed will be extracted and indexed; only new items will be flagged as new (#5) [R] and prune items past a configurable date range or other criteria (#12).
[A] Items will be listed by published or updated time (whichever is newer) in descending order from all configured feeds (#6) ([R] these may also be grouped by the feed source (#13)).
[A] Items will be able to be read within the site (by the content in the feed), and will provide a link to the original item that opens in a new window/tab. (#7)
[R] From within the item being read, that item may be kept as new (#7), or may be bookmarked (bookmarked items are immune from purging) (#14).
[R] Items may also be reviewed by feed, regardless of whether the items is read or unread. (#13)
[R] Bookmarked items will be listed similar to unread items (either all or by feed). (#14)
[R] An authorized user can search the by text within items, which can include all read/unread items or be restricted to bookmarked items. (#15)

Technical Stuff

The software will use vanilla PHP 8.3 for the server and SQLite 3.x for the database.

This software will allow one or multiple users to subscribe to RSS feeds and read the articles from those feeds. Below, items starting with [A] will be done before the first alpha release, and items starting with [R] will be completed (or deferred) before the software goes beta. After a testing period, v1 will be released. **Users** - [A] There will be a single-user / no-password mode, where any user hitting the site is assumed to be the only user. (#3) - [R] There will also be modes where that single user can provide a password, and modes that support multiple users with passwords. (#9) **Feeds** - [A] An authorized user will have the ability to add feeds by URL. (#4) - [R] A feed may also be added by providing a site's URL, and the software will extract the feed from the provided HTML. (#10) - [A] Feeds will be refreshed on-demand (#5), [R] or on a configurable schedule (#11). **Items** - [A] The items in an RSS feed will be extracted and indexed; only new items will be flagged as new (#5) [R] and prune items past a configurable date range or other criteria (#12). - [A] Items will be listed by published or updated time (whichever is newer) in descending order from all configured feeds (#6) ([R] these may also be grouped by the feed source (#13)). - [A] Items will be able to be read within the site (by the content in the feed), and will provide a link to the original item that opens in a new window/tab. (#7) - [R] From within the item being read, that item may be kept as new (#7), or may be bookmarked (bookmarked items are immune from purging) (#14). - [R] Items may also be reviewed by feed, regardless of whether the items is read or unread. (#13) - [R] Bookmarked items will be listed similar to unread items (either all or by feed). (#14) - [R] An authorized user can search the by text within items, which can include all read/unread items or be restricted to bookmarked items. (#15) **Technical Stuff** The software will use vanilla PHP 8.3 for the server and SQLite 3.x for the database.

danieljsummers referenced this issue from a commit

2024-05-27 02:17:57 +00:00

WIP on docs (#1)

danieljsummers commented

2024-06-12 11:35:09 +00:00

All the above is complete, though the minimum PHP version is now 8.2.

danieljsummers closed this issue

2024-06-12 11:35:09 +00:00

Sign in to join this conversation.

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: bit-badger/feed-reader-central#1