Skip to content

Latest commit

 

History

History
executable file
·
83 lines (60 loc) · 3.26 KB

README.md

File metadata and controls

executable file
·
83 lines (60 loc) · 3.26 KB
Raw

Faalis

Gem Version Build Status Downloads Test Coverage Code Climate Dependency Status Lisence

IMPORTANT NOTE: We are planning for v3.0.0 of Faalis. This version would be a totally different version. If you like to know more or even join this process please visit our website and join th gitter chat.

Faalis is well tuned platform to create web applications as fast as possible. It is built on top of other quality tools, and provides additional features like a robust dashboard, pre-baked authentication and authorization and other cool stuff.

Installation

Simply add these to the end of your Gemfile:

source 'http://rails-assets.org' do
  gem 'rails-assets-sugar'
  gem 'rails-assets-bootstrap-rtl'
  gem 'rails-assets-jquery-knob'
  gem 'rails-assets-bootstrap-daterangepicker'
  gem 'rails-assets-jquery-sparkline'
  gem 'rails-assets-jquery-icheck'
  gem 'rails-assets-admin-lte'
end

gem "faalis"

Then install your project dependencies using bundle command:

bundle install

use faalis:install generator to install faalis into your project by issuing the following command:

rails g faalis:install

Add this to your config/environments/development.rb file

config.action_mailer.default_url_options = { :host => 'localhost:3000' }

In production, :host should be set to the actual host of your application.

Perform rake db:migrate db:seed and enjoy Faalis

NOTE: You can specify the ORM you'd like to use in config/initializers/faalis.rb

Documents

It's easier to starts with Faalis Guides but you can checkout the automated rubydoc docs.

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

Also you can join us in our IRC channel: #Faalis on freenode. ( It will redirect you to #5hit :P )

Credit

Yellowen

Faalis is maintained and funded by Yellowen. Whenever a code snippet is borrowed or inspired by existing code, we try to credit the original developer/designer in our source code. Let us know if you think we have forgotten to do this, and we will do our best to locate the problem and fix it in a timely manner.

License

Faalis is Copyright © 2013-2017 Yellowen. It is free software, and may be redistributed under the terms specified in the LICENSE file.