https://github.com/msurdi/feedo
An RSS/Atom feed reader that runs on your laptop or on almost any free hosting provider or server.
https://github.com/msurdi/feedo
atom feeds rss
Last synced: about 1 year ago
JSON representation
An RSS/Atom feed reader that runs on your laptop or on almost any free hosting provider or server.
- Host: GitHub
- URL: https://github.com/msurdi/feedo
- Owner: msurdi
- Created: 2021-05-28T18:05:52.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2023-06-24T18:31:45.000Z (almost 3 years ago)
- Last Synced: 2025-03-25T04:41:25.878Z (about 1 year ago)
- Topics: atom, feeds, rss
- Language: JavaScript
- Homepage: https://github.com/msurdi/feedo
- Size: 73.8 MB
- Stars: 11
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
[](https://github.com/msurdi/feedo/actions/workflows/test.yml)
# Feedo
An RSS/Atom feed reader that runs on your laptop or on almost any free hosting
provider or server.
## Quick start
This command will start feedo on your computer.
```shell
npm i -g feedo
feedo start -m -s 3h
```
That will start the web application at
[http://localhost:8080](http://localhost:8080/).
## Development environment
1. Install dependencies:
```shell
npm install
```
2. Create a `.env` by copying the provided `.env.example`.
3. Start the service in development mode
```shell
npm run dev
```
## Hosted usage
If instead of running feedo on your own latop, you would prefer to run it on a
server, here are some guides to do so:
### Dokku
If you are using [Dokku](https://dokku.com/), create a new App with `dokku
apps:create ...` and then setup the `DOKKU_*` variables in the `.env file`,
finally deploy it with:
```shell
npm run deploy:dokku
```
Ensure you also setup all the necessary environment variables in dokku, with
`dokku config:set ...`. You can see which ones are supported by looking at the
[.env.example](./.env.example) file.