Popularity

Last commit was almost 3 years ago

View on GitHub

App directory

Gems (view all 0)

Packages

No packages found.

Comfortable Mexican Sofa

a lovely-named CMS

From GitHub

ComfortableMexicanSofa is a powerful Ruby on Rails 5.2+ CMS (Content Management System) Engine

Back-end stack

Nothing special found.

Front-end stack

Nothing special found.

Readme from GitHub

ComfortableMexicanSofa

ComfortableMexicanSofa is a powerful Ruby on Rails 5.2+ CMS (Content Management System) Engine

Features

Simple drop-in integration with Rails 5.2+ apps with minimal configuration
CMS stays away from the rest of your application
Powerful page templating capability using Content Tags
Multiple Sites from a single installation
Multi-Language Support (i18n) (ca, cs, da, de, en, es, fi, fr, gr, hr, it, ja, nb, nl, pl, pt-BR, ru, sv, tr, uk, zh-CN, zh-TW) and page localization.
CMS Seeds for initial content population
Revision History to revert changes
Extendable Admin Area built with Bootstrap 4 (responsive design). Using CodeMirror for HTML and Markdown highlighing and Redactor as the WYSIWYG editor.

Dependencies

File attachments are handled by ActiveStorage. Make sure that you can run appropriate migrations by running: rails active_storage:install
Image resizing is done with with ImageMagick, so make sure it's installed.
Pagination is handled by kaminari or will_paginate. Please add one of those to your Gemfile.

Installation

Add gem definition to your Gemfile:

gem "comfortable_mexican_sofa", "~> 2.0.0"

Then from the Rails project's root run:

bundle install
rails generate comfy:cms
rake db:migrate

Now take a look inside your config/routes.rb file. You'll see where routes attach for the admin area and content serving. Make sure that content serving route appears as a very last item or it will make all other routes to be inaccessible.

comfy_route :cms_admin, path: "/admin"
comfy_route :cms, path: "/"

Quick Start Guide

After finishing installation you should be able to navigate to http://localhost:3000/admin

Default username and password is 'username' and 'password'. You probably want to change it right away. Admin credentials (among other things) can be found and changed in the cms initializer: /config/initializers/comfortable_mexican_sofa.rb

Before creating pages and populating them with content we need to create a Site. Site defines a hostname, content path and its language.

After creating a Site, you need to make a Layout. Layout is the template of your pages; it defines some reusable content (like header and footer, for example) and places where the content goes. A very simple layout can look like this:

<html>
  <body>
    <h1>{{ cms:text title }}</h1>
    {{ cms:wysiwyg content }}
  </body>
</html>

Once you have a layout, you may start creating pages and populating content. It's that easy.

Documentation

For more information on how to use this CMS please refer to the Wiki. Section that might be of interest is the entry
on Content Tags.

Comfy Demo App also can be used as an
example of a default Rails app with CMS installed.

Add-ons

If you want to add a Blog functionality to your app take a look at
ComfyBlog.

[Admin Area Preview](doc/preview.jpg)

Old Versions

CMS for Rails 5.1 doesn't have published gem, but you may use rails 5.1 branch directly.

If you want to use CMS version 1.12 on Rails 5.2 use 1.13 branch directly.

With Rails 4.2 and 5.0 use gem version 1.12.10

With Rails 3.0 use gem version 1.8.5

[CHANGELOG](//github.com/comfy/comfortable-mexican-sofa/releases) is documented
in Github releases.

Contributing

ComfortableMexicanSofa repository can be ran like a regular Rails application in
development environment. It's as easy to work on as any other Rails app out there.
For more detail take a look at [CONTRIBUTING](CONTRIBUTING.md)

Help and Contact

Gitter: https://gitter.im/comfy/comfortable-mexican-sofa

Twitter: @GroceryBagHead

Acknowledgements

Thanks to Roman Almeida for contributing OEM License for Redactor Text Editor