https://github.com/philhawksworth/jamstack-comments-engine

An example of a comments engine you could add to any JAMstack site hosted on Netlify
https://github.com/philhawksworth/jamstack-comments-engine

comments jamstack netlify slack static-site

Last synced: 5 days ago
JSON representation

An example of a comments engine you could add to any JAMstack site hosted on Netlify

• Host: GitHub
• URL: https://github.com/philhawksworth/jamstack-comments-engine
• Owner: philhawksworth
• Created: 2018-03-21T15:21:06.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2023-01-09T22:22:38.000Z (almost 2 years ago)
• Last Synced: 2024-10-23T03:33:30.986Z (13 days ago)
• Topics: comments, jamstack, netlify, slack, static-site
• Language: JavaScript
• Homepage: https://jamstack-comments.netlify.com/
• Size: 1.66 MB
• Stars: 158
• Watchers: 6
• Forks: 44
• Open Issues: 21
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
![Jamstack Comments Engine screengrab](screenshot.jpg)

# Comments engine example.

Comments for your site. With no server to maintain and no Javascript dependency.

Built on Netlify

[![Netlify Status](https://api.netlify.com/api/v1/badges/9859aca9-0a82-49d4-9ae9-eefcbb4c4129/deploy-status)](https://app.netlify.com/sites/jamstack-comments/deploys)

## Setting up

1. Clone the repo and deploy it as a netlify (with one click via this DTN button)

[![Deploy to Netlify](https://www.netlify.com/img/deploy/button.svg)](https://app.netlify.com/start/deploy?repository=https://github.com/philhawksworth/jamstack-comments-engine)

2. Configure a Slack integration on your Slack account

3. Add the required environment variables for:

  - `API_AUTH`

  - `APPROVED_COMMENTS_FORM_ID`

  - `SLACK_WEBHOOK_URL` (You'll need to create and configure [a Slack App](https://api.slack.com/apps?new_app=1))

4. **Add build hook** (`https://app.netlify.com/sites/{SITE_NAME}/settings/deploys#build-hooks`) which will rebuild and deploy the site whenever a new comment is submitted to the approved form

5. **Add a notification** (`https://app.netlify.com/sites/{SITE_NAME}/settings/forms#form-notifications`) which will call our build hook (above) when a new comment is added to the approved comments form.

6. **Add a notification** (`https://app.netlify.com/sites/{SITE_NAME}/settings/forms#form-notifications`) to call our comment handler lambda when a new comment is posted to the comments queue for approval.