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

https://github.com/Hexient-Labs/hence-form

Simple Form Submission Server Side
https://github.com/Hexient-Labs/hence-form

forms heroku rails ruby

Last synced: about 1 year ago
JSON representation

Simple Form Submission Server Side

Awesome Lists containing this project

README

          

[![Code Climate](https://codeclimate.com/github/Hexient-Labs/hence-form/badges/gpa.svg)](https://codeclimate.com/github/Hexient-Labs/hence-form)
[![Issue Count](https://codeclimate.com/github/Hexient-Labs/hence-form/badges/issue_count.svg)](https://codeclimate.com/github/Hexient-Labs/hence-form)
[![Test Coverage](https://codeclimate.com/github/Hexient-Labs/hence-form/badges/coverage.svg)](https://codeclimate.com/github/Hexient-Labs/hence-form/coverage)
[![Build Status](https://travis-ci.org/Hexient-Labs/hence-form.svg?branch=master)](https://travis-ci.org/Hexient-Labs/hence-form)
[![Join the chat at https://gitter.im/hence-form/Lobby](https://badges.gitter.im/hence-form/Lobby.svg)](https://gitter.im/hence-form/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
[![Open Source Love](https://badges.frapsoft.com/os/v2/open-source.svg?v=103)](https://github.com/ellerbrock/open-source-badges/)
[![GPL Licence](https://badges.frapsoft.com/os/gpl/gpl.svg?v=103)](https://opensource.org/licenses/GPL-3.0/)



# Hexient Labs HenceForm

* [Overview](#overview)
* [Example](#example)
* [Deployment](#deployment)
* [Running Locally](#running-locally)
* [License](#license)
* [Contributions](#contributions)

## Overview

Have you ever needed to set up a PHP script to relay form submissions to your email?
Well, you should use your HenceForm instead! No coding, no setup, just a
simple way to relay form data into an email.

1. Create a form on your site and set the `action` attribute on your form
to `https://henceform.hexientlabs.com/you@youremail.com`.

1. Whenever a user fills out and submits the form, we'll send you an email
with that data.

*Note* The first time you submit a form, it will ask you to confirm your email.
After that, you're good to go.

## Example

A form could look like:

```html



Submit

```

You'll then get an email that looks like:





## Deployment

Want to run your own copy of HenceForm? It's simple.

Use the Heroku Deploy button below and set the required configuration
values on the next page

[![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy)

*Note*: Even though we use the free Heroku Redis and Heroku Postgres addons, Heroku
will require that the account you use has a credit card attached to it.

# Running Locally

1. Install the Ruby Version specified in the `.ruby-version` file via RVM or RBenv

1. Install [PostgreSQL](https://www.postgresapp.com) and have it running

1. Install [Redis](https://www.redis.io) and have it running

1. Clone the Repo and `cd` into it

1. Install Ruby dependencies via `bundle install`

1. Copy the `.env.example` file to `.env`

1. Set all values in the `.env` file.
This is already gitignored so don't worry about committing it.

1. Setup the database using `bundle exec rails db:setup`

1. Run the server using `bundle exec rails server`

1. Run the worker using `bundle exec sidekiq -c 5 -v -q default -q mailers`

# License

This project is licensed under the [GPL v3 License](./LICENSE)

# Contributions

![Hexient Labs Logo](readme_images/logo_140.png)

This project is heavily inspired by the amazing [FormSpree](https://www.formspree.io)
project.

This project is lovingly maintained by the [Hexient Labs](https://www.hexientlabs.com)
Engineering Team. If you like this project, consider them for your your next project