![Gitter](https://badges.gitter.im/Join Chat.svg)
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.
- First add
rails-assets
source to yourGemfile
:
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 yourGemfile
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
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.
- Fork it
- Create your feature branch (
git checkout -b my-new-feature
) - Commit your changes (
git commit -am 'Add some feature'
) - Push to the branch (
git push origin my-new-feature
) - Create new Pull Request
Also you can join us in our Gitter
group:
![Gitter](https://badges.gitter.im/Join Chat.svg)
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.
Faalis is Copyright © 2013-2014 Yellowen. It is free software, and may be redistributed under the terms specified in the LICENSE file.