https://github.com/tableflip/post
:love_letter: The TABLEFLIP contact form handler
https://github.com/tableflip/post
Last synced: about 1 year ago
JSON representation
:love_letter: The TABLEFLIP contact form handler
- Host: GitHub
- URL: https://github.com/tableflip/post
- Owner: tableflip
- License: agpl-3.0
- Created: 2016-03-21T15:28:19.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2018-02-14T15:53:22.000Z (over 8 years ago)
- Last Synced: 2025-02-15T12:46:45.998Z (over 1 year ago)
- Language: JavaScript
- Homepage:
- Size: 128 KB
- Stars: 2
- Watchers: 3
- Forks: 2
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# POST - The TABLEFLIP contact form handler
Store and forward data posted to it from forms on static sites.
Data is stored in leveldb.
Periodically sent on to recipients.
## Getting started
Copy `config/defaults.json` to `config/local.json` and fill out your mailgun credentials.
Create a reCAPTCHA key pair here [https://www.google.com/recaptcha/](https://www.google.com/recaptcha/admin#list) for the domain from which you are posting.
In the `post-infrastructure` project add the following two pieces of config
* Place the secret key in config as follows creating a 'lookup table' with your domain as *key* and secret as *value*:
```
{
google: {
captcha: {
"new-domain.name": "_SECRET_KEY_FROM_GOOGLE_"
}
}
}
```
* Add a reference to this in `/roles/post/templates/local.json`
```
{
google: {
captcha: {
"new-domain.name": "{{secret.google.capcha['new-domain.name']}}",
"another-domain": "{{secret.google.capcha['another-domain']}}"
}
}
}
```
**From the command line**
- `npm watch` => to run the site in dev mode, with automagic restarting on change.
- `npm start` => to run it for real.
**Files of note**
- `server.js` is an express app.
- `db.js` initialises a leveldb instance.
- `pages` dir holds our route. `/pages/home` is mounted under `/`
## P O S T usage
Load the google recaptcha api in the `` of the page
```html
```
Create an html form. Set `method="post"` the `action` to point to
`https://post.tableflip.io/butterfield-diet.com`
Replace `butterfield-diet.com` with your domain that will be sending the posts.
```html
Your email address
Any info
function onSubmit (token) {document.getElementById('your-form-id').submit()}
Send
```
The `name` values on your inputs will show up as labels in your notification, to give the values some context.
Use the admin screen at `https://post.tableflip.io/routes` to configure a route for `https://butterfield-diet.com`, to tell it where to send the message, and where to redirect the user afterwards.
## Skip the spam filter
You can be in a situation where you just want to post to post and skip the Google's recaptcha. You can do this by adding a **"skip"** flag on your post's payload:
```json
{
"name": "Bernard",
"email": "bernard@tableflip.io",
"open-source": "true",
"g-recaptcha-response": "skip"
}
```
## Level DB
See: http://dailyjs.com/2013/04/18/leveldb-and-node-1/
For looking up where to send a message to, we have general purpose **domain** routes, that'll be used when a more specific **domain + path** route can't be found.
This let's you configure a default handler for all forms on a site, and occasionally override it for a specific form if you need to. The path can be as deeply nested as you need, it just needs to correspond to the path that you append to https://post.tableflip.io/yoursite.com/path/to/your/special/form/here
```
route!tableflip.io => { email: 'hello@tableflip.io', frequency: 'daily' }
route!tableflip.io/startup => { email: 'hello@tableflip.io', frequency: 'all' }
route!marmalade-productions.com => { email: 'hello@tableflip.io', frequency: 'daily' }
```
We look up for a specific match on domain + path, then a domain match if there isn't a specific match.
1. lookup `tableflip.io/foo/bar`, not found.
2. lookup `tableflip.io`. found; make it so.
---
A [(╯°□°）╯︵TABLEFLIP](https://tableflip.io) side project.