[go: nahoru, domu]

Skip to content

Alchemy is the Open Source Rails CMS framework for the component based web that can be used as classic server side rendered or headless CMS.

License

Notifications You must be signed in to change notification settings

AlchemyCMS/alchemy_cms

 
 

Repository files navigation

Alchemy CMS

Build Status Maintenance Status Code Climate Dependency Status

About

Alchemy is a Rails 3 CMS with a flexible content storing architecture.

Read more on the website and in the guidelines.

Features

  • Highly flexible Templating
  • Gorgious End-User centric interface
  • Multilingual
  • SEO
  • Access Control
  • Fulltext Search
  • RSS Feeds
  • Contactforms
  • Attachments and downloads
  • Powerfull image rendering
  • Extendable
  • Integrates in exsiting Rails Apps
  • Caching
  • BSD License
  • Hostable on any Server that supports RubyOnRails and ImageMagick (Software Requirements)

Rails Version

This version of Alchemy runs with Rails 3.2.8+.

If you are looking for a Rails 3.1 compatible version check the 2.1-stable branch.

If you are looking for a Rails 3.0 compatible version check the 2.0-stable branch.

If you are looking for a Rails 2.3 compatible version check the 1.6-stable branch.

Ruby Version

Alchemy runs under Ruby 1.8.7, Ruby 1.9.2, Ruby 1.9.3 and REE (Ruby Enterprise Edition). We strongly recommend Ruby 1.9.3 for best performance and maximum security.

Installation

Use the installer (recommended):

gem install alchemy_cms
alchemy new my_magicpage

Start the local server:

rails server

Then just switch to your browser and open http://localhost:3000

Upgrading

Projects running with Alchemy CMS version < 2.2 needs to be upgraded.

Use the following Upgrade-Task:

rake alchemy:upgrade

Add to existing Rails project

In your Gemfile:

gem 'alchemy_cms', :github => 'magiclabs/alchemy_cms', :branch => '2.3-stable'

Run in terminal:

bundle install
rake alchemy:install:migrations
rake db:migrate
rake alchemy:db:seed

Tipps

  1. This generator creates all necessary folders and files needed for creating your own page layouts and elements for your website:

     rails generate alchemy:scaffold
    
  2. If you use the ferret full text search (enabled by default), then please add a job to your crontab that reindexes the ferret index.

     cd /path/to/your/alchemy && RAILS_ENV=production rake ferret:rebuild_index > /dev/null
    
  3. You can easily create your element files (for view and editor) depending on the elements.yml with this generator:

     rails generate alchemy:elements --skip
    

Resources

Authors

License