Skip to content

index.md

Latest commit

 

History

History
97 lines (64 loc) · 2.9 KB

index.md

File metadata and controls

97 lines (64 loc) · 2.9 KB

Installation

Installation

Add the gem to your Gemfile and run bundle install

gem 'fae-rails'

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.

Dependencies

Rails

Fae supports Rails >= 4.1.

Sass and sass-rails

Fae requires sass >= 3.4 and sass-rails >= 5.

If you're using Rails 4.1 you'll need to update the versions in the Gemfile:

gem 'sass-rails', '~> 5.0.0'
gem 'sass', '~> 3.4.0'

and run:

$ bundle update sass-rails
$ bundle update sass

fae:install

Fae's installer will do the following:

  • add Fae's namespace and route to config/routes.rb
  • add app/assets/stylesheets/fae.scss for UI color management and custom CSS
  • add app/assets/javascripts/fae.js for custom JS
  • add app/controllers/concerns/fae/nav_items.rb to manage main navigation
  • add Fae's initializer: config/initializers/fae.rb
  • add config/initializers/judge.rb for validation config
  • copies over migrations from Fae
  • runs rake db:migrate
  • seeds the DB with Fae defaults

DB Seed

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.

Version management

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

Easily deploy Fae to Heroku by following Heroku's Rails 4 or Rails 5 install guides. After Rails is successfully configured, install Fae as usual.

The Fae roles will need to be seeded in the remote ENV. Using the Heroku CLI, run the following from your app directory:

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

Assets

Heroku does not store assets. Although this is not officially supported by Fae, it is possible to store assets uploaded to Fae with S3.