cokron / adva_cms Goto Github PK

Welcome to adva-cms
===================
 
adva-cms is a cutting edge open source application platform based on Ruby on
Rails and Rails Engines.

Different from others, adva-cms lives in vendor directory and keeps your main
app directory clean and dandy. So you can reclaim app directory and use it
only for your own application files.

adva-cms makes it extensible: you can only pick those engines/features you really
need for your application and omit the rest. All engines are designed to work
together seamlessly, so the whole platform feels much more consistent for
similar but separate Rails applications.
 
Please check out /doc directory and our site http://adva-cms.org for more info.
 
 
Installation: Release 0.1.1
===========================

Required: Rails 2.2.x, ImageMagick for image handling

rails my-app
cd my-app

git clone git://github.com/svenfuchs/adva_cms.git vendor/adva  # or use git submodule add ...
cd vendor/adva
git checkout -b tag/0.1.1 0.1.1
cd -

ruby vendor/adva/setup.rb     # adds adva rake tasks and required files
rake db:migrate:all           # runs adva-cms migrations

ruby script/server
open http://localhost:3000

You should see adva-cms installation screen.
Fill out the form and you're started, enjoy!


Installation: Edge version using rails template
===============================================

Required: Rails 2.3.1, ImageMagick for image handling

# install Rails 2.3.1 gems if you don't have them already
sudo gem install rails --source http://gems.rubyonrails.org

# install and setup adva-cms using a template
rails my-app -m http://github.com/svenfuchs/adva_cms/raw/master/script/adva-cms.template.rb
cd my-app

# migrate and you're done
rake db:migrate
ruby script/server
open http://localhost:3000

You should see adva-cms installation screen. 
Fill out the form and you're started, enjoy!


Installation: Edge version manually
===================================

Required: Rails 2.3.1 or newer, ImageMagick for image handling

# First install Rails 2.3.1 gems if you don't have it already
sudo gem install rails --source http://gems.rubyonrails.org

rails my-app
cd my-app
git clone git://github.com/svenfuchs/adva_cms.git vendor/adva  # or use: git submodule add ...

rake adva:install:core # installs adva-cms to vendor/plugins/
rake assets:copy       # copies plugin assets to public/
rake db:migrate        # copies engine migrations to app, does usual migration and removes
                       # engine migrations after it's done

ruby script/server
open http://localhost:3000

You should see adva-cms installation screen. 
Fill out the form and you're started, enjoy!


Configuration
=============
 
You can change adva-cms configuration at:
  config/initializers/adva.rb


Development
===========

Please check out /doc directory for high level overview about adva-cms.
 
Running tests for adva-cms version 0.1.2 or newer:
  rake db:test:clone       			# Clones from your development database to test database
  ruby script/test-adva-cms -p 	# Prepares the database and runs all adva-cms tests
  ruby script/test-adva-cms    	# Runs all adva-cms tests without preparing the database
  ruby script/test-adva-cms vendor/adva/engines/adva_wiki # Runs only adva_wiki tests

Please report bugs to Lighthouse: 
  http://artweb-design.lighthouseapp.com/projects/13992-adva_cms/overview
 
Git repository:
  http://github.com/svenfuchs/adva_cms/tree/master
 
adva-cms mailing list:
  http://groups.google.com/group/adva-cms
 
adva-cms irc:
  irc://irc.freenode.net#adva-cms


Developers
==========

Sven Fuchs
Marko Seppä
Clemens Kofler
Priit Tamboom
Thomas R. Koll
Joshua Harvey