https://github.com/charliegerard/event-triggered-netlify-function
Demo showing how to use event-triggered Netlify Functions.
https://github.com/charliegerard/event-triggered-netlify-function
javascript netlify netlify-functions serverless
Last synced: 24 days ago
JSON representation
Demo showing how to use event-triggered Netlify Functions.
- Host: GitHub
- URL: https://github.com/charliegerard/event-triggered-netlify-function
- Owner: charliegerard
- Created: 2021-07-21T09:16:52.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2021-07-21T12:07:06.000Z (almost 4 years ago)
- Last Synced: 2025-03-27T16:40:05.569Z (about 1 month ago)
- Topics: javascript, netlify, netlify-functions, serverless
- Language: HTML
- Homepage:
- Size: 8.79 KB
- Stars: 7
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Event-triggered Netlify Functions
[](https://app.netlify.com/sites/event-triggered-function/deploys)
This is a small demo made with Vanilla JS :heart: to showcase how to use event-triggered Netlify Functions.
This site is deployed on Netlify and when a deploy fails, the function fetches a random GIF and posts it on a Slack channel.
## Local development
If you'd like to try this demo locally, there's a few steps to follow:
- Follow the [Giphy API docs](https://developers.giphy.com/docs/api#quick-start-guide) to get an API key.
- Check the [Slack API docs](https://api.slack.com/) to create an app and get a user ID, channel ID and secret token.
- Clone the repo.
- In the `deploy-failed.js` file, replace the environment variables with your own:
- Either replace directly the `process.env.SOME_KEY` instances with the keys you generated (but don't forget to **not** commit your file), or:
- Create a `.env` file, place all your secrets in there and add `require('dotenv').path("path/to/your/.env/file")` at the top of the function file (and .gitignore it if you decide to commit).
- Run `netlify dev` in your terminal
- Open `http://localhost:8888`
- As this function is usually triggered by a build event, you'll need to write some custom code to trigger it locally, for example:
```javascript
window.onload = () => {
return fetch("/.netlify/functions/deploy-failed");
};
```
And if you followed all the above steps, you should get a new GIF on Slack! :tada:
## Deploy on Netlify
[](https://app.netlify.com/start/deploy?repository=https://github.com/charliegerard/event-triggered-netlify-function)
The fastest way to try this demo would be to deploy it on Netlify and add the following environment variables in the site's settings: `GIPHY_API_KEY`, `SLACK_API_SECRET`, `SLACK_CHANNEL_ID`, `SLACK_USER_ID`.
Trigger a deploy, cancel it, get a GIF on Slack!