Skip to content

Commit

Permalink
added readme
Browse files Browse the repository at this point in the history
  • Loading branch information
carsoncole committed Oct 23, 2020
1 parent ec5f558 commit 38f9a78
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 19 deletions.
33 changes: 16 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,23 @@
# README
# ScoutActivity

This README would normally document whatever steps are necessary to get the
application up and running.
ScoutActivity is a Ruby on Rails application for helping Scout troops solicit and poll for interest in Scouting acitivities. Parents and Scouts can be asked to enter their own ideas, which can then be voted on by everyone.

Things you may want to cover:
## Installation

* Ruby version
The application is configured to be hosted on Heroku, but can be hosted anywhere. The following ENV variables for sending forgotten password emails must be populated in a production environment:

* System dependencies
```ruby
ACTION_MAILER_SMTP_ADDRESS
ACTION_MAILER_SMTP_USER_NAME
ACTION_MAILER_SMTP_PASSWORD
```

* Configuration
In development, you need a use Rails secure credentials and have a`credentials.yml.enc` file that has the following:

* Database creation
```ruby
email:
address: smtp.gmail.com
user_name: username
password: password
```

* Database initialization

* How to run the test suite

* Services (job queues, cache servers, search engines, etc.)

* Deployment instructions

* ...
2 changes: 1 addition & 1 deletion config/credentials.yml.enc
Original file line number Diff line number Diff line change
@@ -1 +1 @@
310zGPR7R8FZ5JH9YKoejwDCVdYsJzWzyeaDwUXr3RHfSnGSt3N76UL6Zw7uC7l7QKHJd0f7zjWDc8iQgDnjRyNMFkL9NLkCbWLOqAfaMygKa/mI6RZQFQ8ZuDplOOYK8OwpAPF9ZIzhoQc1LTy6NMEYnv6MoyiFn4HwVBAVTzWR3BlB6pXKlnWp9Favjj3BbtB2N1p8HEHFyWGnEi8pMuzbwseIxmFgdb9xagFR0JiDehaVKOm1kwSnFSbExcBiZ6NID2C4ikJvPK55Euw8M6uX9uhvlbE8qhOG5KiPLoUAc/75gglZZjrAYgH3qp9fMk295f2Sr4aCJVwLO0sVV2nKwMCKw9PAOWuKpWZ0vXk1rsRn1FGgH9mMIl+rg2yVRo9bJi2FUYq+BgVigt0ZJGK8+if8f9ItkXPnMpL8/yu42oc9dxicuZiRpZTNLSyZVYa9IWJbRNgtAcQepaaOFxdAw3lSM6chV8kjWmz0+DHkx8FdqAjTCBt8LBQvYnUCx1KLmtrIVg==--qM8XGp8Uo8GZDZBF--lVL+95g5xAWwAP2fTWuP9A==
3pN5nOnMBJVFxOwVLpCXjQzztz/IsVtqdJkixsv4t2+QG+68eBahCY74CxUSeAJhQXN/cCNpFYwxxw214udBwyP+Uegu2nZzp8CzjiuysNXhYdxXv+bZ0PkGcCNvq+D2kroSphoOAhmI1ou6FW71JfFkEQCGlKWNS6VoOV4If1Vbq+BAlYvw8iLj0ZOAlfCdB2tkc70/INPymquLh1mvm1T4dMdmHcpMXGZ0GAnHMvILqFU9sr8pwHCZkxgwhF1krFE+WHrK0UJREZ0Tq6iMoYhcAfbF+sDTKXefJ0cjYicUr11YgMBqllm5uA2vJgtSKWzO0ceMaRQ8q0f4pTXt5Dr1d/Vd5F6jIc1N6IHv5V0JslyQBeTvdrZzDJaf3Y9SVP75EVTvgNaVQeCE1Q9tooSHENm1D9CSyGABPvnK3RUZ03VWNhzeYqx+9SwS46gv1fnmQIm7V5lIYLiP9a9Mk7oExGn5F5FXCDUc03tJM9Mp5epqF8qK5XHINnjmhm7d0GgBSQEN6pDc4DQhEfRHTGKsG1Hd+0HWdXH1Bg3ZrSjQ--cBw7DB3Y4slOjdjL--35RMkiApEkz8kwn4NoGJTg==
2 changes: 1 addition & 1 deletion config/environments/development.rb
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@
config.action_mailer.default_url_options = { host: 'localhost:3000' }
config.action_mailer.delivery_method = :smtp #:letter_opener #
config.action_mailer.smtp_settings = {
:address => "smtp.gmail.com",
:address => Rails.application.credentials.email[:user_name],
:port => 587, # Port 25 is throttled on AWS
:user_name => Rails.application.credentials.email[:user_name],
:password => Rails.application.credentials.email[:password],
Expand Down

0 comments on commit 38f9a78

Please sign in to comment.