FeedVault is an open-source web application that allows users to archive and search their favorite web feeds.

Python 100%

Find a file

Joakim Hellsén fb37a9ee88 Add support for images		2024-02-18 00:27:00 +01:00
.github	Update actions/cache action to v4	2024-02-16 04:19:01 +00:00
.vscode	Add feed and item extensions	2024-02-17 21:18:04 +01:00
db	Add support for images	2024-02-18 00:27:00 +01:00
sql	Add support for images	2024-02-18 00:27:00 +01:00
.air.toml	You can now add feeds to the database	2024-02-16 04:56:44 +01:00
.env.example	Read settings from .env	2024-02-17 20:07:21 +01:00
.gitignore	You can now add feeds to the database	2024-02-16 04:56:44 +01:00
add_feed.go	Add support for images	2024-02-18 00:27:00 +01:00
add_item.go	Add support for images	2024-02-18 00:27:00 +01:00
docker-compose.yml	Improve documentation	2024-02-13 07:05:15 +01:00
feeds.go	Add support for images	2024-02-18 00:27:00 +01:00
feedvault.db	You can now add feeds to the database	2024-02-16 04:56:44 +01:00
go.mod	Read settings from .env	2024-02-17 20:07:21 +01:00
go.sum	Read settings from .env	2024-02-17 20:07:21 +01:00
handlers.go	Add support for images	2024-02-18 00:27:00 +01:00
handlers_test.go	Move everything back to root dir	2024-02-14 04:40:48 +01:00
html.go	Add feed and item extensions	2024-02-17 21:18:04 +01:00
html_test.go	Move everything back to root dir	2024-02-14 04:40:48 +01:00
LICENSE	Initial commit	2024-01-23 17:19:23 +01:00
main.go	Read settings from .env	2024-02-17 20:07:21 +01:00
opml.go	Move everything back to root dir	2024-02-14 04:40:48 +01:00
opml_test.go	Move everything back to root dir	2024-02-14 04:40:48 +01:00
quotes.go	Add support for images	2024-02-18 00:27:00 +01:00
README.md	You can now add feeds to the database	2024-02-16 04:56:44 +01:00
sqlc.yaml	Get DB size from Postgres	2024-02-17 04:25:39 +01:00
stats.go	Get DB size from Postgres	2024-02-17 04:25:39 +01:00
validate.go	Move everything back to root dir	2024-02-14 04:40:48 +01:00
validate_test.go	Move everything back to root dir	2024-02-14 04:40:48 +01:00

README.md

FeedVault

A seed vault for your feeds.

FeedVault is an open-source web application written in Golang that allows users to archive and search their favorite RSS, Atom, and JSON feeds. With FeedVault, users can effortlessly add their favorite feeds, ensuring they have a centralized location for accessing and preserving valuable content.

Features

Note: Some features are currently in development.

Unified Feed Archiving: Archive RSS (0.90 to 2.0), Atom (0.3, 1.0), JSON (1.0, 1.1), Dublin Core, and ITunes feeds seamlessly in one centralized location.
Content Search: Easily search your archive for specific content.
Export Options: Export your archive to various formats, including JSON, CSV, HTML, ODS, RST, TSV, XLS, XLSX, or YAML.
API: Access your archive programmatically through a API.
Self-Hosting: Host FeedVault on your own server for complete control over your data.
Privacy-Focused: FeedVault respects user privacy by not tracking or collecting any personal data. It is an ad-free platform that prioritizes user security.

Usage

Visit the FeedVault website.
Sign up for an account or log in if you already have one.
Add your favorite feeds to start archiving content.
Explore, manage, and enjoy your centralized feed archive.

Contributing

All contributions are welcome regardless of skill level or experience.

Please create a new issue before submitting a big pull request. I am probably okay with anything, but I don't want you to waste your time on something that I won't accept.

Try to minimize the number of dependencies you add to the project. If you need to add a new dependency, please create an issue first.

Contact

For any inquiries or support, please create an issue on GitHub.

Development

I use goose and sqlc for database migrations and queries.
- To create a new migration, run goose create <migration_name> sql. Then, edit the file in sql/schema/<date>_<migration_name>.sql and run goose up to apply the migration.
  - You will have to install goose first. See the Goose documentation.
  - You will also have to install sqlc. See the sqlc documentation.
  - You have to set some environment variables for this. See .vscode/settings.json for local development.
- To generate new queries, run sqlc generate.

Thank you for using FeedVault! Happy archiving!