Skip to content
Gem to generate Devise Views in materialize style format.
HTML Ruby Other
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci
.github
bin
lib
test
.codeclimate.json
.gitignore
.mdlrc
.rubocop.yml
.yardopts
CHANGELOG.md
CODE_OF_CONDUCT.md
CONTRIBUTING.md
Gemfile
LICENSE
README.md
Rakefile
devise_materialize.gemspec

README.md

Devise Materialize

CircleCI Code Climate coverage Code Climate maintainability GitHub release Gem Discord

Devise Materialize gem is here to generate you devise view in a materialize styled format with or w/o simple_form. This gem is not intended to live forever in your gemfile. It must be in your gemfile to load the resources needed from the generator. Below in the installation section will detail out which gems to install for all to work.

Installation

Add these lines to your application's Gemfile:

# Required gems so you don't have to add files manually
gem "devise"
gem "materialize-sass"
gem "material_icons"

# Required if using HAML
gem "haml"

# Required if using Slim
gem "slim"

# Required if using Simple Form
gem "simple_form"

gem "devise_materialize", "~>1.2.0"

Usage

devise, materialize-sass and material_icons are required in your gemfile to enable the views to generate without error and in the proper style.

Command Line Flags Description Defaults Options
NAMESPACE What is the model name used for devise Devise Devise, Users, Admins, etc
-f / --form-engine Define a form Engine to use default default, simple_form
-v / --view-engine Define a View Engine to use erb erb, haml, slim

Basic Usage

> rails g devise_materialize:install

This will generate the basic views of devise based on defaults

Parameters Defined

If you plan to use simple form using this gem simple_form_materialize to install a config file with all wrappers defined as used in this gem.

> rails g devise_materialize:install Users --form-engine simple_form --view-engine haml

This will generate the views in simple form usage and HAML syntax

Change Log

Check out the Change Log for new features/bug fixes per release of a new version.

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 build. Gems will be built/release by Owner.

Contributing

Bug Reports, Feature Requests, and Pull Requests are welcome on GitHub at https://github.com/chiefpansancolt/devise_materialize. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

To see more about Contributing check out this document.

  • Fork Repo and create new branch
  • Once all is changed and committed create a pull request.

Ensure all merge conflicts are fixed and CI is passing.

License

Devise Materialize is available as open source under the terms of the MIT License.

You can’t perform that action at this time.