Skip to content

Latest commit

 

History

History
114 lines (75 loc) · 5.72 KB

README.md

File metadata and controls

114 lines (75 loc) · 5.72 KB
Raw

Rails CI Coverage Status Gem Version Gem Downloads GitHub Release Date - Published_At

ComfortableMediaSurfer

ComfortableMediaSurfer is a powerful Ruby 6.1+ CMS (Content Management System) Engine, picking up where ComfortableMexicanSofa left off.

Features

  • Simple drop-in integration with Rails 6.1+ apps with minimal configuration
  • The CMS keeps clear 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.

Compatibility

  • Ruby >= 3.0 with Rails >= 6.1
  • On Ruby 3.x, Rails 7.x + is recommended, since performance is noticably better than on 6.x

Installation

Add gem definition to your Gemfile:

gem "comfortable_media_surfer", "~> 3.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 'user' and 'pass'. 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_media_surfer.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

Old Versions

CHANGELOG is documented in Github releases.

Contributing

ComfortableMediaSurfer can run like any Rails application in development. It's as easy to work on as any other Rails app. For more detail see CONTRIBUTING

Testing

  • bin/rails db:migrate RAILS_ENV=test
  • rake db:test:prepare
  • rake test

Acknowledgements

Copyright 2010-2019 Oleg Khabarov, 2024 ShakaCode LLC Released under the MIT license