/engine

a brand new CMS system with super sexy UI and cool features

Primary LanguageRubyOtherNOASSERTION

LocomotiveCMS

Dependency Status

LocomotiveCMS is a simple but powerful CMS based on liquid templates and mongodb database. At my company (NoCoffee), we use it for our clients when they request a simple website.

If we have to give a couple of features to describe our application, there will be:

  • managing as many websites as you want with one application instance
  • nice looking UI (see http://www.locomotivecms.com for some screenshots)
  • flexible content types
  • content localization out of the box
  • playing smoothly with Heroku, Bushido and MongoHQ
  • inline editing (wip)
  • API

Strategy / Development status

We already developed a fully functional prototype in Rails 2.3.2 with both active record / mongomapper and it worked quite well. We are even using it for some client websites.
Now, our goal is to port our prototype to Rails 3 and migrate from mongomapper to mongoid. Besides, we put a lot of efforts to make it as robust as we can by writing better specs than we wrote for the prototype at first.

Gems

Here is a short list of main gems / technologies used in the application.

  • Ruby 2.x
  • Rails 3.2.17 (Rails 4.0 planned for the beginning of 2014)
  • Mongoid 3.1.5 (with MongoDB 2.x)
  • Liquid
  • Devise
  • Carrierwave
  • Haml
  • Formtastic
  • Cells
  • Coffeescript / Backbone / SASS

Installation

See the installation documentation on the official website

Upgrading

See the engine upgrade guide on the official website

Community

Contributing to LocomotiveCMS

LocomotiveCMS is an open source project, we encourage contributions. If you have found a bug and want to contribute a fix, or have a new feature you would like to add, follow the steps below to get your patch into the project:

  • Install ruby and mongoDB
  • Clone the project git clone git@github.com:locomotivecms/engine.git
  • Setup a virtual host entry for test.example.com to point to localhost
  • Install PhantomJS (Required for the cucumber suite See: https://github.com/jonleighton/poltergeist)
  • Run the tests rake
  • Write your failing tests
  • Make the tests pass
  • Create a GitHub pull request

For new features (especially large ones) it is best to create a topic on the Google group first to make sure it fits into the goals of the project.

Team

Support

Bernd Hauser from designhunger funded the following feature: has_one / has_many between content types.

Credits

Rodrigo Alvarez for his plugin named Congo which gave us a good starting point and for his availability for (very late) tech discussions.

Emmanuel Grard designed the awesome locomotive illustration in the old locomotivecms.com landing page.

Font Awesome for providing the best icons. Make the whole back-office Retina-ready.

Contact

Feel free to contact me at didier at nocoffee dot fr.

Copyright © 2013 NoCoffee, released under the MIT license