andr-andreev / social-rss

📙 Read your Twitter/VK timeline as an RSS-feed

Social RSS

Read your social networks timeline in different formats (RSS, JSON).

Social RSS fully parses API data including avatars, quotes, photos, videos, hashtags, user mentions and urls.

You can read your own timeline as well as user's timelines.

Supported networks / screenshots

Twitter (source post)

VK (source post)

Screenshots made in NewsBlur RSS reader.

Output formats

• RSS 2.0
• JSON

Requirements

• PHP >= 7.2
• Composer

Installation

$ git clone https://github.com/andr-andreev/social-rss.git
$ cd social-rss
$ make install

Configuration

Copy .env.example to .env and configure it as seen below.

$ cp .env.example .env

Twitter

1. Create an application: https://apps.twitter.com/app/new
2. Go to Keys and Access Tokens tab. Press Create my access token button at the bottom of the page
3. Save Consumer Key, Consumer Secret, Access Token and Access Token Secret to .env

VK

1. Create an standalone application: https://vk.com/editapp?act=create
2. Go to Settings tab
3. Open https://oauth.vk.com/authorize?client_id={APP_ID}&scope=wall,friends,offline&redirect_uri=http://oauth.vk.com/blank.html&response_type=code and allow access to your account. You will be redirected to https://oauth.vk.com/blank.html#code={CODE}
4. Open https://oauth.vk.com/access_token?client_id={APP_ID}&client_secret={API_SECRET}&code={CODE}&redirect_uri=http://oauth.vk.com/blank.html. Save access_token to .env

Usage

Configure your webserver, assuming ./web/ is public-accessible directory.

To view your own timeline in default (RSS) format:

http://example.com/feed/{source}

To view user timeline in default (RSS) format:

http://example.com/feed/{source}?username={username}

To specify another format:

http://example.com/feed/{source}?output={format}

where {source} is twitter or vk and {format} is rss or json

Tests

You can run the test suite:

$ make test

Disclaimer

Please note that using this script may be against social networks Terms of Service.