joshvar88 / faalis

A RubyOnRails platform for rapid web application development. Containing a rich and flexible dashboard interface

Faalis


Faalis is a RubyOnRails Platform for rapid web application development. It provides a very robust dashboard subsystem with some fantastic generators and client side framework based on AngularJS to improve productivity as much as possible.

Installation

• First add rails-assets source to your Gemfile:

source 'http://rails-assets.org'

NOTE: Remember to add this source not to replace the default one.

• Add faalis gem and it's dependencies to your Gemfile like:

group :development, :test do
  gem 'rspec-rails', '~> 3.0.0.beta'
  gem "capybara"
  gem "factory_girl_rails", "~> 4.0", :require => false
  gem "database_cleaner"
  gem "email_spec"
  gem "cucumber-rails", :require => false
end

# Current Dashstrap theme for Faalis
gem "dashstrap"

gem "faalis"

• Iinstall your project dependencies using bundle

bundle install

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

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

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

• Ensure you have flash messages in app/views/layouts/application.html.erb. For example (Only if you want to change default layout):

<p class="notice"><%= notice %></p>
<p class="alert"><%= alert %></p>

• Perfrom rails generate faalis:install_all to copy necessary files.
• Add this to your config/routes.rb :

mount Faalis::Engine => "/"
Faalis::Routes.define_api_routes

• Perform rake db:migrate and enjoy Faalis

NOTE: You change the orm you like to use in config/initializers/faalis.rb

Documents

There is couple of guides along side with Ruby and JavaScript API documents inside the source tree. We use yardoc so you can build them easily or look at automated rubydoc docs.

Also take a look at Wiki of Faalis.

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 Gitter group: 

Credit

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 missed to do this.

License

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