Skip to content

Latest commit

 

History

History
53 lines (41 loc) · 1.21 KB

README.md

File metadata and controls

53 lines (41 loc) · 1.21 KB

Mcm

A small content manager that allows you to build custom pages through selecting components in a GUI. Can be mounted as an engine into any Rails app.

Dependencies

Your app needs to have this in order to use this engine:

  • Bootstrap 4 (5 is not fully supported yet)
  • active_storage for image processing.

Installation

Add the gem to your bundle:

$ bundle add mcm --github "magma-labs/mcm"

Install and run migrations by doing:

$ bundle exec rails mcm:install:migrations
$ bundle exec rails db:migrate

Import the default set of components into your database by running:

$ bundle exec rails mcm:sync_components

Setup

Create a config/initializer/mcm.rb file with the following content:

# config/initializer/mcm.rb

Mcm.layout = 'application'
Mcm.admin_layout = 'application'
Mcm.controller_parent = 'ApplicationController'
Mcm.admin_controller_parent = 'ApplicationController'

Mount the engine in the root path of your app:

# config/routes.rb
Rails.application.routes.draw do
  mount Mcm::Engine, at: "/"
end

Contributing

Help wanted!

License

The gem is available as open source under the terms of the MIT License.