https://github.com/dreikanter/feeder

Imaginary friends automata for Freefeed.net
https://github.com/dreikanter/feeder

content-aggregation content-processing freefeed hacktoberfest rss sharing social-media

Last synced: about 2 months ago
JSON representation

Imaginary friends automata for Freefeed.net

• Host: GitHub
• URL: https://github.com/dreikanter/feeder
• Owner: dreikanter
• License: mit
• Created: 2016-08-20T22:31:00.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2024-10-27T12:01:46.000Z (about 2 months ago)
• Last Synced: 2024-10-28T15:09:21.566Z (about 2 months ago)
• Topics: content-aggregation, content-processing, freefeed, hacktoberfest, rss, sharing, social-media
• Language: Ruby
• Homepage: https://frf.im
• Size: 3.42 MB
• Stars: 7
• Watchers: 3
• Forks: 7
• Open Issues: 17
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Security: SECURITY.md

Awesome Lists containing this project

README

        
# Freefeed Feeder

Feeder is a content sharing service for [freefeed.net](https://freefeed.net), an open source social network.

Feeder can monitor RSS, ATOM, Reddit, Twitter, YouTube, and other web feed updates, normalize the content and share clean and readable excerpts on FreeFeed.

Check out https://freefeed.net/xkcd for example.

![](https://raw.githubusercontent.com/dreikanter/feeder/master/screenshots/feeds-index.png)

## Development

**Development environment setup:**

Build Docker containers and run Rails server:

```sh

docker-compose build

docker-compose up app

```

Install or update packages:

```sh

docker-compose run app bundle install

docker-compose run app bundle update

```

Shell:

```sh

docker-compose run sh

```

Rake tasks (`rails -T | grep feeder`):

```sh

rails feeder:pull                     # Pull one specific feed: "rake feeder:pull[feed_name]"

rails feeder:pull_all                 # Pull all feeds

rails feeder:pull_stale               # Pull stale feeds

rails feeder:subs                     # Update Freefeed subscriptions count

rails feeder:clean                    # Clean old data points

rails feeder:import_nitter_instances  # Import public Nitter instances list

```

## Deployment

How it works:

- `master` is the integration branch.

- `release` is the release branch.

- Head revision of the `release` branch is on production.

- Merge `master` to `release` immediately before the deployment.

- `./bin/release_master` script pushes head from `master` to `release`.

Required configuration:

- `DATABASE_URL` - PostgreSQL DB URL.

- `RAILS_ENV` - Rails env name (`development`, `test`, `production`).

- `REDIS_URL` - Redis instance URL (for example, `redis://1.1.1.1:6379/0`).

- `HONEYBADGER_API_KEY` - Honeybadger API key for errors reporting (Project → Settings → API keys).

- `FREEFEED_BASE_URL` - Freefeed instance API root URL (i.e. `https://freefeed.net`).

- `FREEFEED_TOKEN` - Freefeed auth token.

Ansible playbooks for deployment and server provisioning:

- https://github.com/dreikanter/feeder-ansible

## Communication

If you have a question or want to report a bug, please open an issue.

## References

- Status page: https://frf.im

- Project wiki: https://github.com/dreikanter/feeder/wiki

- Service account on Freefeed: https://freefeed.net/feeder