== Welcome to El Dorado

El Dorado is a full-stack community web application written in Ruby/Rails. It features a forum, 
event calendar, group chat, file sharing, random headers, avatars, themes, and privacy settings.

http://almosteffortless.com/eldorado


== Requirements 

Rails: http://guides.rubyonrails.org/getting_started.html
Git: http://book.git-scm.com/2_installing_git.html


== Installation

# If you don't have git, you can download El Dorado here: http://almosteffortless.com/eldorado

git clone git://github.com/trevorturk/eldorado.git eldorado
cd eldorado
cp config/database.example.yml config/database.yml
cp config/config.example.yml config/config.yml
rake db:create
rake db:schema:load
script/server
# http://localhost:3000/


== Deployment on Heroku

# Follow the local installation instructions above, then...

sudo gem install heroku
heroku create
# Set the variables for your production environment in config/config.yml
rake s3:create
rake heroku:config
git push heroku master
heroku rake db:schema:load
heroku open
# Read more about Heroku here: http://heroku.com/


== More Deployment Strategies

http://almosteffortless.com/2009/06/24/install-ruby-enterprise-phusion-passenger-and-el-dorado-on-debian-lenny/


== Upgrading

# Always back up your database and files before performing an upgrade
# Consider using Git and Capistrano to make upgrades easier (see config/deploy.example.rb)
# Download El Dorado from http://almosteffortless.com/eldorado or http://github.com/trevorturk/eldorado/
# Replace the files in your installation except for uploaded files, avatars, etc in public/
# Note that the git url was been changed on 6/24/09 to git://github.com/trevorturk/eldorado.git
# Review possible config changes in config/config.example.yml (required as of 6/24/09)
# Migrate to the latest database schema ("rake db:migrate" or "cap deploy:migrations")


== Upgrading on Heroku

# From your local eldorado directory...

git pull
# Review possible config changes in config/config.example.yml
rake heroku:config
git push heroku master
heroku rake db:migrate
heroku open


== Thanks

NewAthens.org, Matt Brent, Artie Jordan, Max Mearsheimer, Timothy O'Connell, Matz et al. (Ruby), 
DHH et al. (Rails), Rick Olson and Josh Goebel (Beast), Rickard Andersson et al. (PunBB), 
Matt Mullenweg et al. (WordPress), Michael Heilemann et al. (k2), Josh Peek, and Wilhelm Chung.


== MIT License

Copyright (c) 2006-2009 Trevor Turk

Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation
files (the "Software"), to deal in the Software without
restriction, including without limitation the rights to use,
copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following
conditions:

The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.