Git Product home page Git Product logo

feedon's Introduction

FeeDon (fork)

This is a fork of https://git.sr.ht/~vesto/feedon

FeeDon is a service for Mastodon instances that allows users to generate RSS feeds from their home timeline, local timeline, and any lists they've created. Technically speaking you can mostly do this by just subscribing to individual users' timelines in your RSS reader, but this doesn't work well if you want to keep your RSS reader in-sync with who you follow or follow users with private posts.

FeeDon in action

Getting started

While it's perfectly possible to run your own instance, it's much easier to use somebody else's instance. If this takes off I hope to run a publicly accessible instance for others, but given that the project is still in its early phases I'm limiting my instance for a select number of testers.

If you'd like to help me test things out and provide feedback, feel free to send an email and I'll consider adding you in.

Setup

Setting up a development instance is a bit tricky, as you really need to expose your instance to the internet at large in order for it to work properly. There are a variety of ways to accomplish this, and for the sake of brevity I'm going to avoid getting too far into the weeds on this for the time being. My personal dev setup involves running the Flask server on a VPS that uses Caddy as a reverse proxy (with SSL).

To set up the project itself, run the following commands to clone the repo and install dependencies:

git clone https://github.com/senz/feedon.git

Open the project in devcontainer and run the following commands:

Once dependencies have been installed you'll need to create a .env file to configure your server:

SECRET_KEY=[long random string]
BASE_URL=https://your.instance.domain.com

Finally, you can spin up your server by running the following command:

make dev

If all goes well you should have a development server up and running and can navigate to your BASE_URL to log in and create some RSS feeds.

feedon's People

Contributors

stevenleeg avatar senz avatar dependabot[bot] avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.