Permalink
Browse files

Splitting out mailer.rb into an example file

  • Loading branch information...
1 parent fec53dc commit 779ba2ec93564ffd74f9a0bf2a4d7aa703a9d19e @konklone konklone committed Sep 16, 2009
Showing with 19 additions and 1 deletion.
  1. +11 −1 README.md
  2. +8 −0 config/initializers/mailer.rb.example
View
@@ -18,6 +18,7 @@ The campaign management area for TransparencyCorps is at transparencycorps.org/a
Inside the campaign management area, a campaign manager can create, update, and delete campaigns (but only their own, obviously). Campaign ownership is given to a particular user; they cannot be jointly owned by more than one user account. Some basic statistics regarding that user's campaigns will be shown in a sidebar inside this area.
+
## API
The API has two parts - creating a new task, and completing a task.
@@ -44,4 +45,13 @@ When a user completes a task on a campaign, that campaign should perform a POST
http://transparencycorps.org/tasks/complete
-The only parameter to send is "task_key", with the value being the task_key that was originally given as a parameter when the user first created their task.
+The only parameter to send is "task_key", with the value being the task_key that was originally given as a parameter when the user first created their task.
+
+## Developing Locally
+
+To set up this app to run locally:
+
+* copy config/initializers/mailer.rb.example to config/initializers/mailer.rb and fill in your mailer settings
+* copy config/database.yml.example to config/database.yml and fill in your database settings
+* run "rake db:schema:load" to initialize the database
+* run "rake db:fixtures:load" to get a starting admin user account, with username/password: user1/test
@@ -0,0 +1,8 @@
+ActionMailer::Base.smtp_settings = {
+ :address => '',
+ :port => 25,
+ :user_name => '',
+ :password => '',
+ :authentication => :plain,
+ :domain => ''
+}

0 comments on commit 779ba2e

Please sign in to comment.