Add the gem to your Gemfile and run
Run the installer
$ rails g fae:install
After the installer completes, visit
/admin and setup your first user account. That should automatically log you in to your blank Fae instance.
Fae supports Rails >= 4.1.
sass >= 3.4 and
sass-rails >= 5.
If you’re using Rails 4.1 you’ll need to update the versions in the
gem 'sass-rails', '~> 5.0.0' gem 'sass', '~> 3.4.0'
$ bundle update sass-rails $ bundle update sass
Fae’s installer will do the following:
app/assets/stylesheets/fae.scssfor UI color management and custom CSS
app/controllers/concerns/fae/nav_items.rbto manage main navigation
config/initializers/judge.rbfor validation config
Fae comes with a rake task to seed the DB with defaults:
rake fae:seed_db RAILS_ENV=<your_env>
If you ran the installer, the task will be run automatically. But if you are setting up an established Fae instance locally or deploying to a server, running this will get you setup with some defaults.
Fae follows semantic versioning, so you can expect the following format:
major.minor.patch. Patch versions add bugfixes, minor versions add backwards compilable features and major versions add non-backward compatible features.
heroku run rake fae:seed_db
If this returns a
ActiveRecord::StatementInvalid: PG::UndefinedTable: ERROR: relation "fae_roles" does not exist error, make sure your tables exist:
heroku run rake db:migrate
Heroku does not store assets. Although this is not officially supported by Fae, it is possible to https://github.com/wearefine/fae/issues/324#issuecomment-334578748.