Formulus for Rails

Getting Started

Formulus Rails is a gem for attaching client-side form validations to your server-rendered <form> tags by providing Ruby helpers for the NPM package formulus.

Installation

Install the gem and add to the application's Gemfile by executing:

bundle add formulus

Install the JavaScript package:

yarn add formulus

or using Importmaps:

bin/importmap pin formulus

Initialize Formulus in application.js:

// application.js
+import Formulus from 'formulus'
+Formulus.initialize({})

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake test to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and the created tag, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/marcoroth/formulus-rails. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the Formulus project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.