This will connect your extension with Gopher so the two systems can talk.
... ⏱ it should only take Glitch a miinute to create your editable copy of our open source starter extension. While you're waiting, read on.
Gopher Express is an open source Gopher Extension to kickstart your next great idea. Need inspiration? Visit the Gopher Extension Idea Board.
Out of the box, it's a simple email reminder.
If you send an email to [anything]@[your-extension-domain].gopher.email, you will receive en email reminder in 15 minutes. ]
-
When a user emails [anything]@[your-extension].gopher.email, Gopher fires the
task.created
webhook to your extension, which is handled inroutes/gopherWebhooks
. -
When a reminder becomes due, Gopher fires the
task.triggered
webhook, again handled inroutes/gopherWebhooks.js
-
User settings and the OAuth connection process are handled in
public/index.html
.
The code is well commented with examples and links to docs throughout, so have a look around.
Gopher Express just uses Node.js and Express, making it very portable.
To run your extension locally:
- export to Github or Download (in Glitch's advanced settings)
- run
npm install
, thennpm run dev
- to allow the Gopher API to send webhooks to your extension,
run
npm run ngrok
to map a publicly accessible domain to your local install - copy
.env.example
into.env
and add your environment details - edit your extension's settings on gopher.email to reflect your new environment.
From here you can easily deploy your extension to Heroku, Zeit or any other Node.js platform.
Create issues, provide feedback or issue PRs on the Gopher Express Github Repo
- If you did not arrive here from the Gopher Admin UI, start by setting up a new extension.
- Read the Gopher API Docs to learn about the Gopher platform.
- Join us in Slack or send us an email with feedback!