https://github.com/imjasonh/push

https://github.com/imjasonh/push

Last synced: about 1 month ago
JSON representation

• Host: GitHub
• URL: https://github.com/imjasonh/push
• Owner: imjasonh
• License: apache-2.0
• Created: 2023-09-05T15:31:26.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-09-06T12:37:41.000Z (over 1 year ago)
• Last Synced: 2024-10-14T16:51:38.455Z (3 months ago)
• Language: Go
• Size: 29.3 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# `push`

This is an experimental Go backend and JavaScript frontend for sending push notifications to a browser.

This is mainly a learning exercise for me to learn how to do this.

Maybe someday I'll do something useful with it.

## Setup

To bootstrap, create empty files named `gh-client-id` and `gh-secret`. We'll fill these in later.

### Generate a keypair

You'll also need to generate a keypair, which will be used to sign the JWTs used to authenticate the push notifications.

```

go run ./ keygen

```

## Deploying to Cloud Run

```

gcloud auth login

gcloud auth application-default login

terraform init

terraform apply -auto-approve

```

This will print a URL to the deployed service, for example:

```

url = "https://push-blahblah-blah.a.run.app"

```

This packages up the Go backend using `ko_build`, and runs the service with secret access to the private key you generated before, and a Cloud SQL database to store the push subscription endpoint, and GitHub user info.

### Get a GitHub client ID and secret

Create a new GitHub OAuth app here: https://github.com/settings/developers

For the redirect URL, use the URL printed by Terraform, with `/auth/callback` appended to it, for example:

```

https://push-blahblah-blah.a.run.app/auth/callback

```

Update the empty files named `gh-client-id` and `gh-secret` that you created before, with the client ID and secret, respectively.

You'll need to `terraform apply` again to update the new secret values.

### Teardown

Things cost money. To make this stop costing money, teardown the resources you created:

```

terraform destroy

```

## How it works

First you go through a GitHub OAuth flow, which asks for permission to interact with your GitHub notifications, and stores the resulting access token in a cookie.

Then you set up the push notification, which asks for permission to bug you with notifications, and stores the resulting subscription endpoint and your GitHub token in the database.

Then (TODO) the Go backend will poll GitHub for notifications, and send them to the frontend via the push subscription endpoint.