kill-the-newsletter/README.md

1.6 KiB

Kill the Newsletter!

Convert email newsletters into Atom feeds

Convert email newsletters into Atom feeds

Source .github/workflows/main.yml

Running Locally

Install Node.js and run:

$ npm install
$ npm start

The web server will be running at http://localhost:8000 and the email server at smtp://localhost:2525.

Deployment

  1. Create a deployment SSH key pair:

    $ ssh-keygen
    
  2. Add the public key (id_rsa.pub) to DigitalOcean and to GitHub as a Deploy key for the repository.

  3. Add the private key (id_rsa) to GitHub as a Secret called SSH_PRIVATE_KEY.

  4. Create a DigitalOcean droplet.

  5. Configure DNS:

    Type Host Value
    A @ <droplet-ip>
    CNAME www kill-the-newsletter.com
    MX @ kill-the-newsletter.com
  6. Setup the server:

    $ npx pm2 deploy package.json production setup
    
  7. Push to GitHub, which will trigger the Action that deploys the code and starts the server.