Skip to content

Commit

Permalink
Update README file
Browse files Browse the repository at this point in the history
  • Loading branch information
poojagupta committed Jul 11, 2009
1 parent 64beea8 commit 5b34c49
Showing 1 changed file with 15 additions and 15 deletions.
30 changes: 15 additions & 15 deletions README
Expand Up @@ -2,18 +2,18 @@ How to get risealumni up and running

START BY MAKING SURE your ruby gems are version 1.3.4 or greater:
* (sudo) gem update --system

Then add the github repo to your gems:
* gem sources -a http://gems.github.com


* risealmuni runs on Ruby on Rails, so first you need to get rails running. Go download rails (http://rubyonrails.org/down) and follow it's instructions to get rails running.
* The directions in this README file assume some knowledge of rails, but I'll go through it a bit here first.
* The first thing to do is install the ruby gems that are required. For each gem listed in the README, at the command line, do something like "gem install [gem name]" or "sudo gem install [gem name]".
* The next thing to do is set up your database (steps 1-4 in the README). risealumni is setup to use MySQL by default, so just follow the instructions in the README and configure the files for your computer.
* Skip step 5.
* Now setup global variable (site name and url and stuff) (steps 6-13) and change the (r)html and css to suit your taste.
* In dev mode, search (steps 14-16) should work right out of the box (assuming you install the gems). The search instructions are really for a production environment.
* Start risealumni with the typical "./script/server" and point your browser to "http://localhost:3000".
* risealmuni runs on Ruby on Rails, so first you need to get rails running. Go download rails (http://rubyonrails.org/down) and follow it's instructions to get rails running.
* The directions in this README file assume some knowledge of rails, but I'll go through it a bit here first.
* The first thing to do is install the ruby gems that are required. For each gem listed in the README, at the command line, do something like "gem install [gem name]" or "sudo gem install [gem name]".
* The next thing to do is set up your database (steps 1-4 in the README). risealumni is setup to use MySQL by default, so just follow the instructions in the README and configure the files for your computer.
* Skip step 5.
* Now setup global variable (site name and url and stuff) (steps 6-13) and change the (r)html and css to suit your taste.
* In dev mode, search (steps 14-16) should work right out of the box (assuming you install the gems). The search instructions are really for a production environment.
* Start risealumni with the typical "./script/server" and point your browser to "http://localhost:3000".


Instructions:
Expand Down Expand Up @@ -61,6 +61,10 @@ See these posts for tips:
http://b.lesseverything.com/2007/9/26/installing-imagemagick-and-rmagick-on-mac-os-x
http://www.randycullom.com/chatterbox/archives/2006/12/installing_imag.html

Installing Starling and Workling
See these posts for tips:
http://railscasts.com/episodes/128-starling-and-workling

Setup the databases:

1. Edit config/database.yml.tmp to reflect the database names you would like to use.
Expand All @@ -78,12 +82,12 @@ Setup default values:
8. Edit config/environments/development.rb and production.rb to suit your tastes. (Specifically config.action_mailer.delivery_method)
9. Change the values in config/initializers/global_variables.rb to match your site and domain.(Specifically SITE_NAME_FULL,SITE_NAME, SITE, MAILER_TO_ADDRESS, MAILER_FROM_ADDRESS, ADMIN_RECIPIENTS)
10. Edit the ActionMailer settings in config/initializers/global_variables.rb to match your domain.(Specifically "address","domain","user_name","password")
12. Paste "your login" and "password" in config/twitter.yml.
12. Paste "Your twitter login" and "Your twitter password" in config/twitter.yml.
13. Go to the section "About flickr integration" and follow the steps to either use flickr or not.
14. Edit public/404.html, public/500.html, app/views/account_mailer/*
15. Edit application.css to suite your tastes.
16. Edit tos,academics,contact,credits,history and about_us pages in app/views/home/tos,app/views/home/.
17. paste your "Your domain" and "Your gmaps api key" in in config/gmaps_api_key.yml.
17. Paste "Your domain" and "Your gmaps api key" in config/gmaps_api_key.yml.

About flickr integration
------------------------
Expand All @@ -97,10 +101,6 @@ If you WANT to have flickr integration in your application, follow these setup i
Facebook Configuration
----------------------

0. Get a publicly available host:
* dyndns.org
* static IP

1. Add the Developer Application.

2. Create a New Application.
Expand Down

0 comments on commit 5b34c49

Please sign in to comment.