Skip to content

Commit 01e73f1

Browse files
committed
Note development utilities in readme
1 parent b93763e commit 01e73f1

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -109,6 +109,14 @@ irb(main):001:0> User.last.update_attribute(:role, :admin)
109109

110110
6. Visit http://localhost:3000/manage and set up the hackathon as needed
111111

112+
### Development Utilities
113+
114+
- **Mail View** - Email templates can be previewed at http://localhost:3000/rails/mailers
115+
- **Mail Catcher** - When active, emails will be captured by MailCatcher instead of slipping into a black hole (no emails are ever sent in development). Visit [mailcatcher.me](http://mailcatcher.me/) and follow instructions under "How" to get setup.
116+
- **Guard** - Automatically runs tests based on the files you edit. `bundle exec guard`
117+
- **Coverage** - Test coverage can be manually generated via the `bin/rails coverage:run` command. Results are then made available in the `coverage/` directory.
118+
- **Sidekiq** - Run background jobs (such as emails) and view active & completed jobs. Sidekiq is automatically started with Docker - a dashboard is available at http://localhost:3000/sidekiq (_also available in production_).
119+
112120
## License
113121

114122
The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

0 commit comments

Comments
 (0)