https://github.com/cliffano/feedpaper

A feed reader + readability mashup for reading on handheld devices
https://github.com/cliffano/feedpaper

feedpaper nodejs terraform website

Last synced: 7 days ago
JSON representation

A feed reader + readability mashup for reading on handheld devices

• Host: GitHub
• URL: https://github.com/cliffano/feedpaper
• Owner: cliffano
• License: mit
• Created: 2010-11-10T03:10:47.000Z (almost 14 years ago)
• Default Branch: main
• Last Pushed: 2022-12-11T19:47:37.000Z (almost 2 years ago)
• Last Synced: 2024-10-10T19:45:33.110Z (28 days ago)
• Topics: feedpaper, nodejs, terraform, website
• Language: HCL
• Homepage: https://feedpaper.cliffano.com
• Size: 3.48 MB
• Stars: 5
• Watchers: 2
• Forks: 1
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        


[![Build Status](https://github.com/cliffano/feedpaper/workflows/CI/badge.svg)](https://github.com/cliffano/feedpaper/actions?query=workflow%3ACI)




Feedpaper

---------

Feedpaper is a feed reader + readability mashup for reading on handheld devices.

This is handy for anyone who wants to speed-read the articles from a personalised list of web site feeds.

This is an experimental project using serverless architecture with App.js, Terraform, and Amazon Web Services.

Architecture

------------

[![Architecture Diagram](https://raw.github.com/cliffano/feedpaper/master/architecture.jpg)](https://raw.github.com/cliffano/feedpaper/master/architecture.jpg)

| Component      | Description                                                                        |

|----------------|------------------------------------------------------------------------------------|

| feedpaper-web  | Single page App.js web app served as AWS S3 static website                         |

| feedpaper-api  | Content API using AWS API Gateway, and content fetcher using AWS Lambda            |

| feedpaper-data | Content storage using AWS DynamoDB with scheduled content expirer using AWS Lambda |

Installation

------------

Set AWS resources:

* Create an S3 bucket for storing Terraform state files

* Create an IAM group with the following managed policies:

    * AWSLambdaFullAccess

    * IAMFullAccess

    * AmazonS3FullAccess

    * AmazonAPIGatewayInvokeFullAccess

    * AmazonDynamoDBFullAccess

    * AWSLambdaDynamoDBExecutionRole

    * AmazonAPIGatewayAdministrator

Download Feedpaper code:

    git clone https://github.com/cliffano/feedpaper

Configuration

-------------

Create `feedpaper.json`, `feeds.json`, `terraform.tfvars`, `backend-feedpaper-api.tf`, `backend-feedpaper-data.tf`, and  `backend-feedpaper-web.tf` files under a designated configuration directory (e.g. `/path/to/conf_dir`).

Have a look at [conf/ci](https://github.com/cliffano/feedpaper/tree/master/conf/ci) for example configuration files.

Set up the following environment variables:

    export FEEDPAPER_ENV=local

    export FEEDPAPER_CFG=/path/to/conf_dir

    export TF_CFG_BUCKET=

    export TF_CFG_REGION=

Ensure domain name is configured in [Typekit's kit](https://typekit.com/account/kits) setting, and publish the kit, and republish. Wildcard domains no longer work at least since last tested in mid 2017.

Usage

-----

Create content storage:

    make create-data-prd

Create content API:

    make create-api-prd

Create single page web app:

    make create-web-prd

Delete all components:

    make delete-all-prd

Colophon

--------

Articles:

* [Do You Find Websites Hard To Read On The iPhone? Try FeedTouch](http://blog.cliffano.com/2011/02/19/do-you-find-websites-hard-to-read-on-the-iphone-try-feedtouch/)