Skip to content

Gem providing simple Contact Form functionality with a Rails 3+ Engine.

License

Notifications You must be signed in to change notification settings

rickthomasjr/contact_us

 
 

Repository files navigation

Contact Us

A Rails 3+ Engine providing a basic contact form.

I removed the formtasic dependency from the gem. This one little form does not justify that depenency. Have a look at the original repo here

INSTALLATION

In your Gemfile, add the following dependencies:

gem 'contact_us', :git => 'git://github.com/sch1zo/contact_us.git'

From Rails.root run:

$ bundle
$ bundle exec rake contact_us:install

In config/initializers/contact_us.rb modify:

config.mailer_to = "contact@please-change-me.com"

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

config.mailer_to = "contact@yourdomain.com"

CONFIGURATION

The generator copies the view files to app/views/contact_us, and you can customize them to suit your needs.

You may also update your locales under config/locales/contact_us.en.yml or create your own. Please feel free to submit your own locales so that other users will hopefully find this gem more useful.

USAGE

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

INTEGRATION TESTS

Contact Us has 100% test coverage, and provides simple integration specs you can drop directly into your apps test suite if you use RSpec & Capybara.

Simply copy the spec/integration/contact_us_lint_spec.rb file, and add it to your integration specs.

ISSUES

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

CONTRIBUTING

In the spirit of free software, everyone is encouraged to help improve this project.

Here are some ways you can contribute:

  • by using prerelease versions
  • by reporting bugs
  • by suggesting new features
  • by translating to a new language
  • by writing or editing documentation
  • by writing specifications
  • by writing code (no patch is too small: fix typos, add comments, clean up inconsistent whitespace)
  • by refactoring code
  • by resolving issues
  • by reviewing patches

TODO

  • Add new language translations

Copyright (c) 2011 Jeff Dutil, released under the MIT license.

About

Gem providing simple Contact Form functionality with a Rails 3+ Engine.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Ruby 81.1%
  • JavaScript 18.9%