Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/wawandco/gontact

Simple contact form service in Go
https://github.com/wawandco/gontact

Last synced: 2 days ago
JSON representation

Simple contact form service in Go

Host: GitHub
URL: https://github.com/wawandco/gontact
Owner: wawandco
License: mit
Created: 2015-12-09T19:53:39.000Z (almost 9 years ago)
Default Branch: master
Last Pushed: 2016-05-12T13:18:31.000Z (over 8 years ago)
Last Synced: 2024-06-20T16:45:27.573Z (5 months ago)
Language: Go
Homepage: http://wawand.co
Size: 279 KB
Stars: 0
Watchers: 5
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

## GOntact

GOntact is a simple service to send contact form data by email, its propose is to provide a simple service that could be used by any website against Slack or multiple transactional email services such as Mandril, MailGun, and SendGrid.

GOntact provides a simple POST endpoint `/contact`, where it expects to receive the following parameters, that will be sent to your `GONTACT_EMAIL` or a given Slack.

- Name
- Email (optional)
- Address
- Subject (optional)
- Message
- Website Address (optional)

GOntact returns `422` if required parameters are not being passed, otherwise it will return `201`, if there is any provider error it returns a `50X` error.

### Security

GOntact is secured by a environment variable `GONTACT_TOKEN` that should be passed on the request's `X-Gontact-Token` header.

[TODO: JWT]

### Providers

GOntact built in providers:

#### Slack

In order to activate this one please set `GONTACT_PROVIDER=SLACK` in your Environment.
It uses the following Env variables:

- SLACK_WEBHOOK_URL (Required)
- SLACK_CHANNEL (optional default: "notifications")
- SLACK_USERNAME (optional default: "Gontact")
- SLACK_EMOJI (optional default: "mailbox")

#### Mandrill

In order to activate this one please set `GONTACT_PROVIDER=MANDRILL` in your Environment.
It uses the following Env variables:

- MANDRILL_KEY (Required)
- MANDRILL_TO (Required)
- MANDRILL_FROM (Required)
- MANDRILL_SUBJECT (optional default: "Contact")

#### SendGrid (comming soon)
#### MailGun (comming soon)
#### SMTP (comming soon)