Sha256: 4454c6815c92b72402f88b87a3974ca6734b3ff266bd6b5073e8e56c43e63e6b
Contents?: true
Size: 1.29 KB
Versions: 17
Compression:
Stored size: 1.29 KB
Contents
# Softwear::Lib
TODO: Write a gem description
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'softwear-lib'
```
And then execute:
$ bundle
Or install it yourself as:
$ gem install softwear-lib
## Usage
To use apps locally without auth_server:
<br />
<br />
<code>$ AUTH_SERVER=false bundle exec rails s</code>
<br />
<br />
Uses data from local users.yml.
<br />
Expected format for users.yml:
<pre>
user's email:
first_name: user's first name
last_name: user's last name
profile_picture: local file location
roles:
- role1
- role2
- rolen
rights:
- right1
- right2
- rightn
</pre>
To include error handling in your app, add:
<br />
<pre>
Include Softwear::ErrorCatcher
helper Softwear::Auth::EmailsHelper
</pre>
to your application controller.
<br />
<br />
For error styling and animation add:
<br />
<pre>
*= require animate/animate
.box-info-error{
background: "your desired color here";
}
</pre>
to your application.css file.
## Contributing
1. Fork it ( https://github.com/[my-github-username]/softwear-lib/fork )
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 a new Pull Request
Version data entries
17 entries across 17 versions & 1 rubygems