README
¶
Foragd
A beautiful, web based, online feed reader.
Keep your RSS, Atom and other syndication sources in one place. Stay up to date with news, blogs and other online sources, across your mobile, tablet, desktop and laptop.
Homepage
📔 Table of Contents
- :notebook_with_decorative_cover: Table of Contents
🌟 About the Project
Foragd is an online, web-based feed reader for all syndication formats (RSS, Atom, JSONFeed).
What Makes Foragd Different?
- Focused on reading content, not tracking totals: not trying to shoehorn feeds into an email-like interface and not showing unread counts. Straightforward homepage, subscription, and article views.
- Powerful Search: fast and powerful searching. Find that article mentioning that thing from that site a while back, easily.
- Easy Filtering: easily filter articles within a subscription by keyword, phrase, category, or author. No complex filter building, just easy
+/-operators. For example:alcoholic drinks + -"rum based" +daiquiri
📷 Screenshots
👾 Tech Stack
Server
Database
🎯 Features
- Mobile and Desktop Friendly. Foragd is a web based online app. It works in any browser on any device, anywhere.
- Article Filtering. Filter articles in subscriptions by text/phrase, category or authors, with easy to use operators.
- Content Comes First. Simple UI. Big images. Beautiful typography. Let the content shine.
- Powerful Search. Full-text search across subscriptions and articles. Quickly access subscriptions and perform actions from the search bar.
- Subscription customisation. Set a nickname for your subscriptions. Add your own categories to easily group and find similar content.
- Subscription and article favorites. Mark subscriptions and articles as favorites, to quickly access them later.
- Group subscriptions. Combine multiple subscriptions to present a unified view of articles from any of them. Make it easy to keep up with similar posts across different sources.
- Search subscriptions. Use the powerful search to find what you need. Save the search terms as a search subscription to always find new articles that match. Great for keeping track of news or topics across multiple subscriptions.
🧰 Getting Started
‼ Prerequisites
- Podman/Docker.
- Elasticsearch.
- Auth0.
- Stripe.
- Resend.
- GCP.
⚙ Installation
TBA.
🧪 Running Tests
TBA.
🏃 Run Locally
TBA.
🚩 Deployment
TBA.
👀 Usage
TBA.
👋 Contributing
Contributions are always welcome!
See contributing.md for ways to get started.
📜 Code of Conduct
TBA.
⚠ License
Distributed under the AGPL-3.0-or-later License. See LICENSE for more information.
🤝 Contact
Immanent Tech — hello@immanent.tech
Project Link: https://github.com/immanent-tech/foragd
💎 Acknowledgements
Documentation
¶
There is no documentation for this package.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package cli contains functionality for the command-line interface of the service.
|
Package cli contains functionality for the command-line interface of the service. |
|
Package config provides a global config store that other packages can utilise for fetching/storing configuration.
|
Package config provides a global config store that other packages can utilise for fetching/storing configuration. |
|
Package models provides primitives to interact with the openapi HTTP API.
|
Package models provides primitives to interact with the openapi HTTP API. |
|
providers
|
|
|
elastic/aggregations
Package aggregations contains objects and methods for processing Elasticsearch aggregations.
|
Package aggregations contains objects and methods for processing Elasticsearch aggregations. |
|
elastic/bulk
Package bulk contains methods and structures for handling Elasticsearch bulk operations.
|
Package bulk contains methods and structures for handling Elasticsearch bulk operations. |
|
elastic/ilm
Package ilm contains wrappers that help with creating ILM policies.
|
Package ilm contains wrappers that help with creating ILM policies. |
|
elastic/query
Package query contains methods for building Elasticsearch queries.
|
Package query contains methods for building Elasticsearch queries. |
|
elastic/templates
Package templates contains wrappers for helping with creating index and component templates.
|
Package templates contains wrappers for helping with creating index and component templates. |
|
Package scheduler contains code for the scheduler backend that handles managing background jobs for the application.
|
Package scheduler contains code for the scheduler backend that handles managing background jobs for the application. |
|
jobs
Package jobs implements a common type for quartz jobs and specific types and methods to execute different kinds of jobs.
|
Package jobs implements a common type for quartz jobs and specific types and methods to execute different kinds of jobs. |
|
queue
Package queue implements a quartz.JobQueue using Elasticsearch as the storage backend.
|
Package queue implements a quartz.JobQueue using Elasticsearch as the storage backend. |
|
forms
Package forms contains methods for handling form decoding and encoding.
|
Package forms contains methods for handling form decoding and encoding. |
|
handlers
Package handlers contains chainable handlers/middleware for routing.
|
Package handlers contains chainable handlers/middleware for routing. |
|
session
Package session contains methods and objects for managing user sessions.
|
Package session contains methods and objects for managing user sessions. |
Click to show internal directories.
Click to hide internal directories.