https://github.com/feedreaderco/api

Feed Reader API
https://github.com/feedreaderco/api

api docker feedreader nodejs redis rss

Last synced: about 1 month ago
JSON representation

Feed Reader API

• Host: GitHub
• URL: https://github.com/feedreaderco/api
• Owner: feedreaderco
• Created: 2014-01-24T07:41:07.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2022-09-24T09:22:36.000Z (almost 2 years ago)
• Last Synced: 2024-04-14T04:55:25.830Z (5 months ago)
• Topics: api, docker, feedreader, nodejs, redis, rss
• Language: JavaScript
• Homepage: https://api.feedreader.co
• Size: 200 KB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 8
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• awesome-starred - feedreaderco/api - Feed Reader API (nodejs)

README

        
# Feedreader API

This is an API to subscribe to RSS/Atom feeds. Feeds can be organized into folders, and labels can be applied to articles. The folders and labels are stored in Redis. Articles are stored on S3.

## Installation

### AWS Config

Create a file with your AWS credentials, to store articles on S3. The file will need to be in the format `{ "accessKeyId": "id", "secretAccessKey": "secret" }`

### Redis

1. If necessary, install dev tools (for example, with `sudo yum install "development tools"`)

2. `wget http://download.redis.io/redis-stable.tar.gz`

3. `tar xvzf redis-stable.tar.gz`

4. `cd redis-stable`

5. `make && redis-server`

### API

1. `npm install -g feedreader-api`

2. `feedreader-api --aws-config aws-config.json`

## api.feedreader.co

The API is running at api.feedreader.co