Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/mlafeldt/dilbert-feed

Enjoy Dilbert in your RSS feed reader without any ads
https://github.com/mlafeldt/dilbert-feed

aws cdk dilbert recreational rss rust serverless typescript

Last synced: about 2 months ago
JSON representation

Enjoy Dilbert in your RSS feed reader without any ads

Host: GitHub
URL: https://github.com/mlafeldt/dilbert-feed
Owner: mlafeldt
License: apache-2.0
Archived: true
Created: 2017-09-30T18:08:57.000Z (over 6 years ago)
Default Branch: main
Last Pushed: 2023-05-01T13:28:37.000Z (about 1 year ago)
Last Synced: 2024-02-07T12:49:01.751Z (5 months ago)
Topics: aws, cdk, dilbert, recreational, rss, rust, serverless, typescript
Language: Rust
Homepage:
Size: 2.26 MB
Stars: 29
Watchers: 4
Forks: 2
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Lists

awesome-cdk - dilbert-feed - A serverless application written in Go that allows you to enjoy Dilbert in your RSS feed reader without any ads. (Training Materials and Sample Code / Multi-accounts setup)
awesome-cdk - dilbert-feed
awesome-serverless-rust - Dilbert comic feed

README

# dilbert-feed

## Note: The discontinuation of the Dilbert comic strip on March 12, 2023 has made the project futile in its current form.

[![CI](https://github.com/mlafeldt/dilbert-feed/workflows/Rust/badge.svg)](https://github.com/mlafeldt/dilbert-feed/actions)

Enjoy [Dilbert](https://dilbert.com/) in your RSS feed reader without any ads!

Unfortunetly, Dilbert's official feed now forces you to go to the website:

> Dilbert readers - Please visit Dilbert.com to read this feature. Due to changes with our feeds, we are now making this RSS feed a link to Dilbert.com.

This serverless application provides a custom feed with direct access to Dilbert comics that gets updated every day.

For some background information, check out my article on [Recreational Programming with Serverless](https://sharpend.io/recreational-programming-with-serverless/).

PS: The Lambda functions used to be [written in Go](https://github.com/mlafeldt/dilbert-feed/tree/golang), now they're [powered by Rust](https://github.com/mlafeldt/dilbert-feed/pull/6). 💪

## Architecture

![](architecture.png)

## Requirements

You need the following to build and deploy dilbert-feed:

- Node.js + Yarn
- Rust + `rustup target add aarch64-unknown-linux-gnu`
- (On macOS, you also need the corresponding [cross compiler toolchain](https://artofserverless.com/rust-lambdas-macos/))
- Make

## Deployment

Follow these steps to deploy your own dilbert-feed instance to AWS.

Set AWS region and credentials in environment:

```console
export AWS_REGION=eu-central-1
export AWS_ACCESS_KEY_ID=...
export AWS_SECRET_ACCESS_KEY=...
```

Configure the heartbeat URL, e.g. as provided by [Healthchecks.io](https://healthchecks.io/):

```console
aws ssm put-parameter --overwrite --name /dilbert-feed-dev/heartbeat-endpoint --type String --value
aws ssm put-parameter --overwrite --name /dilbert-feed-prod/heartbeat-endpoint --type String --value
```

Build the Lambdas and deploy the CDK stack:

```console
# Bootstrap AWS CDK once
make bootstrap

# Deploy development environment
make dev

# Deploy production environment
make prod
```

Among other things, the stack outputs will show the URL of the RSS feed, which you can then subscribe:

```console
dilbert-feed-prod.FeedUrl = https://dilbert-feed-example.s3.amazonaws.com/v2/rss.xml
```

## Usage

The serverless stack will update the feed automatically. However, you can also invoke the Lambda functions manually.

Get the comic strip for today:

```console
$ ./invoke dilbert-feed-prod-get-strip
{
"date": "2019-10-22",
"title": "Best Employees",
"image_url": "https://assets.amuniversal.com/87b83e10c7460137c2df005056a9545d",
"strip_url": "https://dilbert.com/strip/2019-10-22",
"upload_url": "https://dilbert-feed-example.s3.amazonaws.com/strips/2019-10-22.gif"
}
```

Get the comic strip for a specific date:

```console
$ ./invoke dilbert-feed-prod-get-strip --payload '{"date":"2016-01-01"}'
{
"date": "2016-01-01",
"title": "Forgetting Meetings",
"image_url": "https://assets.amuniversal.com/1a6be66079e101332131005056a9545d",
"strip_url": "https://dilbert.com/strip/2016-01-01",
"upload_url": "https://dilbert-feed-example.s3.amazonaws.com/strips/2016-01-01.gif"
}
```

Get the comic strips for the last 30 days:

```console
for i in $(seq 0 30); do date=$(gdate -I -d "today -$i days"); ./invoke dilbert-feed-prod-get-strip --payload "{\"date\":\"$date\"}"; done
```

Generate the RSS feed:

```console
$ ./invoke dilbert-feed-prod-gen-feed
{
"feed_url": "https://dilbert-feed-example.s3.amazonaws.com/v2/rss.xml"
}
```