miniflux.app

command module
Version: v0.0.0-...-87d5898 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 17, 2021 License: Apache-2.0 Imports: 1 Imported by: 0

README

Miniflux 2

Miniflux is a minimalist and opinionated feed reader:

  • Written in Go (Golang)
  • Works only with Postgresql
  • Doesn't use any ORM
  • Doesn't use any complicated framework
  • Use only modern vanilla Javascript (ES6 and Fetch API)
  • Single binary compiled statically without dependency
  • The number of features is voluntarily limited

It's simple, fast, lightweight and super easy to install.

Official website: https://miniflux.app

Documentation

The Miniflux documentation is available here: https://miniflux.app/docs/ (Man page)

Screenshots

Default theme:

Default theme

Dark theme when using keyboard navigation:

Dark theme

Credits

Documentation

Overview

Miniflux is a feed reader application.

Source Files

Directories

Path Synopsis
Package cli implements command line arguments for Miniflux application.
Package cli implements command line arguments for Miniflux application.
Package client implements a client library for the Miniflux REST API.
Package client implements a client library for the Miniflux REST API.
Package config handles configuration management for the application.
Package config handles configuration management for the application.
Package crypto implements helpers related to cryptography.
Package crypto implements helpers related to cryptography.
Package errors handles localized errors.
Package errors handles localized errors.
Package fever implements Fever API endpoints.
Package fever implements Fever API endpoints.
http
client
Package client provides an HTTP client builder.
Package client provides an HTTP client builder.
cookie
Package cookie provides functions to build cookies.
Package cookie provides functions to build cookies.
request
Package request contains helper functions to work with the HTTP request.
Package request contains helper functions to work with the HTTP request.
response
Package response contains everything related to HTTP responses.
Package response contains everything related to HTTP responses.
response/html
Package html contains HTML response functions.
Package html contains HTML response functions.
response/json
Package json contains JSON response functions.
Package json contains JSON response functions.
response/xml
Package xml contains XML response functions.
Package xml contains XML response functions.
route
Package route contains helper functions to work with defined routes.
Package route contains helper functions to work with defined routes.
Package locale handles the internationalization of the application.
Package locale handles the internationalization of the application.
Package logger handles application log messages with different levels.
Package logger handles application log messages with different levels.
Package model contains all data structures used by the application.
Package model contains all data structures used by the application.
Package oauth2 abstracts different OAuth2 providers.
Package oauth2 abstracts different OAuth2 providers.
Package reader implements everything related to feed parsing.
Package reader implements everything related to feed parsing.
atom
Package atom provides an Atom feed parser.
Package atom provides an Atom feed parser.
browser
Package browser handles website crawling.
Package browser handles website crawling.
date
Package date provides a feed date parser.
Package date provides a feed date parser.
encoding
Package encoding handles workarounds to deal with encoding edge cases found into feeds.
Package encoding handles workarounds to deal with encoding edge cases found into feeds.
icon
Package icon provides all the logic to download website icons.
Package icon provides all the logic to download website icons.
json
Package json provides a JSON feed parser.
Package json provides a JSON feed parser.
opml
Package opml provides an OPML parser and writer.
Package opml provides an OPML parser and writer.
parser
Package parser provides a generic feed parser that abstract all different formats.
Package parser provides a generic feed parser that abstract all different formats.
processor
Package processor applies rules and sanitize content for feed entries.
Package processor applies rules and sanitize content for feed entries.
rdf
Package rdf provides a RDF feed parser.
Package rdf provides a RDF feed parser.
readability
Package readability implements a web page scraper that returns only relevant content.
Package readability implements a web page scraper that returns only relevant content.
rewrite
Package rewrite provides functions to manipulate feed contents.
Package rewrite provides functions to manipulate feed contents.
rss
Package rss provides a RSS feed parser.
Package rss provides a RSS feed parser.
sanitizer
Package sanitizer implements a HTML sanitizer that removes unsafe elements.
Package sanitizer implements a HTML sanitizer that removes unsafe elements.
scraper
Package scraper implements a web page crawler.
Package scraper implements a web page crawler.
subscription
Package subscription implements the logic to find subscriptions on a website.
Package subscription implements the logic to find subscriptions on a website.
xml
service
httpd
Package httpd implements the HTTP service.
Package httpd implements the HTTP service.
scheduler
Package scheduler implements the scheduler service.
Package scheduler implements the scheduler service.
Package storage implements a set of functions to interact with the database.
Package storage implements a set of functions to interact with the database.
Package tests contains API integration tests.
Package tests contains API integration tests.
Package timer implements utility functions to measure the execution time of a block of code.
Package timer implements utility functions to measure the execution time of a block of code.
Package timezone contains helper functions to work with timezones.
Package timezone contains helper functions to work with timezones.
ui
Package ui implements handlers to render to user interface.
Package ui implements handlers to render to user interface.
form
Package form handles HTML form validation and serialization.
Package form handles HTML form validation and serialization.
session
Package session provides helper functions to work with the user session.
Package session provides helper functions to work with the user session.
static
Package static contains assets for the user interface.
Package static contains assets for the user interface.
view
Package view handles template parameters.
Package view handles template parameters.
Package url implements a set of utility functions to parse URL.
Package url implements a set of utility functions to parse URL.
Package version contains application and build information.
Package version contains application and build information.
Package worker implements the background workers.
Package worker implements the background workers.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL