fae icon indicating copy to clipboard operation
fae copied to clipboard

CMS for Rails. For Reals.

Fae

CMS for Rails. For Reals.

Code Climate

Like many Rails CMS engines, Fae delivers all the basics to get you up and running quickly: authentication, authorization, a sleek UI, form helpers, image processing and workflows. But unlike other engines, Fae's generated models, controllers, and views are built to customize and scale.

Fae 2.0 supports Rails 5.0 to 5.2, support for Rails 4.x is deprecated as of Fae 2.0.

Installation

  1. Add the gem to your Gemfile and run bundle install
gem 'fae-rails'
  1. Run the installer
$ rails g fae:install
  1. Visit /admin and setup your super admin account

Documentation

For full documentation visit: https://www.faecms.com/documentation

Topics

  • Quickstart Guide
  • Installation
  • Generators
  • Navigation Setup
  • Initializer
  • Models
  • Controllers
  • Fae Model and Controller Concerns
  • Override Uploaders and Classes
  • Pages and Content Blocks
  • Custom JS, CSS and Helpers
  • Root Settings
  • Caching

Features

  • Global Search
  • Filtering, Pagination and Sorting
  • Authorization
  • Multi-Language Support
  • Cloning
  • Change Tracker
  • Slugger
  • Disabling Environments
  • Form Field Label & Helper Text Manager
  • Netlify Deploy Monitor

Tutorials

  • Setting Up GraphQL with Fae
  • Setting Up Images and Files
  • Adding Dynamic Relationships to Pages
  • Adding Conditional Validations
  • Custom Image Processing
  • Overriding The Landing Page
  • Overriding The Markdown Helper
  • Devise Action Mailer Configuration
  • Setting Up Parent/Child Objects
  • Configuring With Existing Devise Setup

Helper/DSL Docs

  • Fae Styles
  • Form Helpers
  • Nested Form Helpers
  • View Helpers
  • Fae Partials

Contributing

  • Running Fae Locally
  • Fae Standards
  • Share Your Creation

Upgrading

Changelog

MIT License