More at More Faalis

Getting Started with Faalis

In this guide we will review the whole Faalis platform at once.

This guide covers getting up and running with Faalis.

After reading this guide, you will know:

1 Guide Assumptions

This guide is designed for beginners who want to get started with a Faalis application from scratch. It does not assume that you have any prior experience with Faalis. Also you need to know about general concepts of Rails framework. However, to get the most out of it, you need to have some prerequisites installed:

2 What is Faalis generally?

Faalis is development platform which provides lots of functionality for developers to create their apps much easier. For example Faalis provides a very flexible and easy to use dashboard system. Dashboard system is an administration panel and a user dashboard to easily manage different resource on the application. Most of web applications need such facility.

There are other features like dashboard in Faalis. That's why make it a good platform to speed up your development process and make better applications.

Lots of great tools been used in Faalis, tools that you might used on daily basis. Tools like Pundit, Devise and other greate tools.

Faalis is a RubyOnRails Platform for rapid web application development. It provides a very robust dashboard subsystem with some fantastic generators to improve productivity as much as possible.

3 Installation

Simply add these to the end of your Gemfile:

source '' 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'

gem "faalis"

If you want to install faalis from github just replace previous gem "faalis" with this:

gem "faalis", github: 'Yellowen/Faalis'

Then install your project dependencies using bundle

bundle install

use faalis:install generator to install faalis into your project.

rails g faalis: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.

Perform rake db:migrate db:seed and enjoy Faalis

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

Perform rake db:migrate db:seed. If you're using different database engine rather than sqlite, then you have to create the db first.

Done. Now you're ready to start developing your application using Faalis. Have fun.


You're encouraged to help improve the quality of this guide.

Please contribute if you see any typos or factual errors. To get started, you can read our documentation contributions section.

You may also find incomplete content, or stuff that is not up to date. Please do add any missing documentation for master. Make sure to check Edge Guides first to verify if the issues are already fixed or not on the master branch. Check the Faalis Guides Guidelines for style and conventions.

If for whatever reason you spot something to fix but cannot patch it yourself, please open an issue.

And last but not least, any kind of discussion regarding Ruby on Rails documentation is very welcome in the rubyonrails-docs mailing list.