luccamordente / hyalin Goto Github PK

A Rails 4+ Engine providing a basic contact form.

Hyalin requires:

• Ruby >= 2.0.0
• Rails >= 4.0.0

It is also recommended to use SimpleForm in order to hook into your apps custom form builders. Heavily inspired on jdutil/contact_us

In your Gemfile, add the following dependencies:

gem 'hyalin', '~> 0.1.0'

From Rails.root in your Terminal run:

bundle
bundle exec rake hyalin:install

In config/initializers/hyalin.rb modify:

config.mailer_to = "[email protected]"

Change to the email address you would like to receive the form submissions at for example:

config.mailer_to = "[email protected]"

By default the emails from field will be the email entered by the user to easily reply, but this may not be allowed if your required to verify your sending email addresses. You may also specify an email address for the notification emails from field:

config.mailer_from = "[email protected]"

To copy the view files to app/views/hyalin, and customize them to suit your needs run:

bundle exec rake hyalin:copy_views

To copy the locale files to config/locales/hyalin.*.yml, and customize them to suit your needs run:

bundle exec rake hyalin:copy_locales

Please feel free to submit your own locales so that other users will hopefully find this gem more useful in your language.

Visit your website and navigate to /messages/new to see the form in action.

Please report any bugs or feature requests to the Github issues page @ https://github.com/indefinido/hyalin/issues

This project rocks and uses WTFP-LICENSE