Skip to content

Latest commit

 

History

History
54 lines (36 loc) · 1.25 KB

README.md

File metadata and controls

54 lines (36 loc) · 1.25 KB
Raw

tests

Feedo

An RSS/Atom feed reader that runs on your laptop or on almost any free hosting provider or server.

feedo_intro

Quick start

This command will start feedo on your computer.

npm i -g feedo
feedo start -m -s 3h

That will start the web application at http://localhost:8080.

Development environment

  1. Install dependencies:

    npm install

  2. Create a .env by copying the provided .env.example.

  3. Start the service in development mode

    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, create a new App with dokku apps:create ... and then setup the DOKKU_* variables in the .env file, finally deploy it with:

    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 file.