{"id":16111832,"url":"https://github.com/cliffano/feedpaper","last_synced_at":"2025-04-13T21:41:16.277Z","repository":{"id":1172511,"uuid":"1067203","full_name":"cliffano/feedpaper","owner":"cliffano","description":"A feed reader + readability mashup for reading on handheld devices","archived":false,"fork":false,"pushed_at":"2022-12-11T19:47:37.000Z","size":3650,"stargazers_count":5,"open_issues_count":3,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-27T12:02:42.685Z","etag":null,"topics":["feedpaper","nodejs","terraform","website"],"latest_commit_sha":null,"homepage":"https://feedpaper.cliffano.com","language":"HCL","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/cliffano.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2010-11-10T03:10:47.000Z","updated_at":"2024-08-25T00:19:16.000Z","dependencies_parsed_at":"2023-01-11T15:49:59.969Z","dependency_job_id":null,"html_url":"https://github.com/cliffano/feedpaper","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cliffano%2Ffeedpaper","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cliffano%2Ffeedpaper/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cliffano%2Ffeedpaper/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cliffano%2Ffeedpaper/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cliffano","download_url":"https://codeload.github.com/cliffano/feedpaper/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248788864,"owners_count":21161726,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["feedpaper","nodejs","terraform","website"],"created_at":"2024-10-09T19:45:37.871Z","updated_at":"2025-04-13T21:41:16.243Z","avatar_url":"https://github.com/cliffano.png","language":"HCL","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cimg align=\"right\" src=\"https://raw.github.com/cliffano/feedpaper/master/avatar.jpg\" alt=\"Avatar\"/\u003e\n\n[![Build Status](https://github.com/cliffano/feedpaper/workflows/CI/badge.svg)](https://github.com/cliffano/feedpaper/actions?query=workflow%3ACI)\n\u003cbr/\u003e\n\nFeedpaper\n---------\n\nFeedpaper is a feed reader + readability mashup for reading on handheld devices.\n\nThis is handy for anyone who wants to speed-read the articles from a personalised list of web site feeds.\n\nThis is an experimental project using serverless architecture with App.js, Terraform, and Amazon Web Services.\n\nArchitecture\n------------\n\n[![Architecture Diagram](https://raw.github.com/cliffano/feedpaper/master/architecture.jpg)](https://raw.github.com/cliffano/feedpaper/master/architecture.jpg)\n\n| Component      | Description                                                                        |\n|----------------|------------------------------------------------------------------------------------|\n| feedpaper-web  | Single page App.js web app served as AWS S3 static website                         |\n| feedpaper-api  | Content API using AWS API Gateway, and content fetcher using AWS Lambda            |\n| feedpaper-data | Content storage using AWS DynamoDB with scheduled content expirer using AWS Lambda |\n\nInstallation\n------------\n\nSet AWS resources:\n\n* Create an S3 bucket for storing Terraform state files\n* Create an IAM group with the following managed policies:\n    * AWSLambdaFullAccess\n    * IAMFullAccess\n    * AmazonS3FullAccess\n    * AmazonAPIGatewayInvokeFullAccess\n    * AmazonDynamoDBFullAccess\n    * AWSLambdaDynamoDBExecutionRole\n    * AmazonAPIGatewayAdministrator\n\nDownload Feedpaper code:\n\n    git clone https://github.com/cliffano/feedpaper\n\nConfiguration\n-------------\n\nCreate `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`).\nHave a look at [conf/ci](https://github.com/cliffano/feedpaper/tree/master/conf/ci) for example configuration files.\n\nSet up the following environment variables:\n\n    export FEEDPAPER_ENV=local\n    export FEEDPAPER_CFG=/path/to/conf_dir\n    export TF_CFG_BUCKET=\u003caws_s3_bucket_name\u003e\n    export TF_CFG_REGION=\u003caws_region\u003e\n\nEnsure 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.\n\nUsage\n-----\n\nCreate content storage:\n\n    make create-data-prd\n\nCreate content API:\n\n    make create-api-prd\n\nCreate single page web app:\n\n    make create-web-prd\n\nDelete all components:\n\n    make delete-all-prd\n\nColophon\n--------\n\nArticles:\n\n* [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/)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcliffano%2Ffeedpaper","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcliffano%2Ffeedpaper","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcliffano%2Ffeedpaper/lists"}