Coder Social home page Coder Social logo

hello's Introduction

Hello

Enjoyable Rails Authentication.

We are very excited and looking forwards to our release of version 0.1.0

Please take a look at our issues, all help is appreciated.

Status

Build Status Code Climate Code Climate Dependency Status Inline docs

Tested With

Ruby Versions Rails Versions
Ruby 2.2.2 Rails 4.2.*
JRuby (submit a PR) Rails 5 beta
RBX (submit a PR)

Running Tests

Please read Running Tests

Install

Add this line to your application's Gemfile:

gem 'hello', github: 'hello-gem/hello' # latest from github while this gem is in rapid development
gem 'bcrypt', '~> 3.1' # bcrypt is highly recommended

And then execute:

bundle install
bundle exec rails generate hello:install
bundle exec rake db:migrate

Customizing - behavior and views

These files are generated when you install this gem.

They are simple to customize, just open them.

├── app/
│   ├── controllers/
│   │   ├── hello/
│   │   │   └── concerns/
│   │   │       └── [...optional...]
│   │   ├── onboarding_controller.rb
│   │   └── users_controller.rb
│   │
│   ├── models/
│   │   ├── credential.rb
│   │   ├── active_session.rb
│   │   └── user.rb
│   │
│   ├── views/
│   │   ├── hello/
│   │   │   └── [...optional...]
│   │   ├── layouts/
│   │   │   └── application.html.erb
│   │   ├── onboarding/
│   │   │   └── index.html.erb
│   │   └── users/
│   │       ├── index.html.erb
│   │       └── show.html.erb
│   │
├── config/
│   └── initializers
│       └── hello.rb
│
└── db/
    └── migrate/
        ├── 1_create_credentials.hello.rb
        ├── 2_create_accesses.hello.rb
        └── 3_create_users.hello.rb

Customizing

class User < ActiveRecord::Base
  def user?
    %w(user webmaster).include?(role)
  end
end

module Hello
  module Concerns
    module EmailSignUpOnSuccess

      def on_success
        deliver_welcome_email
        deliver_confirmation_email
        redirect_to root_path
      end

    end
  end
end

Demo

Want to see it in action?

References

Support

Thank You

Tim Lucas, John Nunemaker, Dan Everton and Johan Andersson or their open source gem user_agent_parser. As well as Tobie Langel and everybody involved in BrowserScope (full list), as our device and browser detection derives from their open-source work.

Iain Hecker for his open source gem http_accept_language that helps us understand browser's favorite locales.

Brian Landau and Ryan Foster for NavLynx as well as everybody on the Bootstrap Team as we use these open source projects on our generated view code.

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request

Contributing With Translations

Link to Translation files

Link to Our Locale Contributors

  1. change the initializer config.locales = %w(en es pt-BR <NL>)
  2. dummy initializer spec/dummy/config/initializers/hello.rb
  3. initializer template lib/generators/hello/install/templates/initializer.rb
  4. update locale test in spec/controllers/localization_spec.rb
  5. create and modify the locale file config/locales/hello.<NEW_LANGUAGE>.yml
  6. ensure consistency with this test bundle exec rspec spec/others/localization_consistency_spec.rb spec/controllers/localization_spec.rb
  7. Thank You! Submit your Pull Request :)

Versioning

Hello uses Semantic Versioning 2.0.0

Copyright

Copyright 2013-2014 James Pinto – Released under MIT License

Additional

Look for these terms in the source code

"TODO", "KNOWNBUG"

Known bugs

  1. (Rails 4.0 only) Top Feature Set: Current User Feature Set: Settings Feature: Cancel Account Invalid Scenarios Validation: has_many restrict_with_error Scenario 2: User has dependent grandchildren

To Do

  1. One translation missing: config/locales/*.yml

  2. Test this method: Hello::Railsy::Controller::AccessRestrictionConcern::ClassMethods#restrict_if_role_is

  3. Generate Access Token Feature

hello's People

Contributors

acamino avatar brodock avatar davidzhu001 avatar demental avatar evandrodp avatar gomayonqui avatar marcelobarreto avatar mpapis avatar mschnack avatar rthbound avatar sadjow avatar th1agoalmeida avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.