From 01e73f18ce5b9010569ff193157ee55e138ab845 Mon Sep 17 00:00:00 2001 From: Stuart Olivera Date: Sat, 20 Apr 2019 02:06:03 -0400 Subject: [PATCH] Note development utilities in readme --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index 9a914fe7a..fb324cfbd 100644 --- a/README.md +++ b/README.md @@ -109,6 +109,14 @@ irb(main):001:0> User.last.update_attribute(:role, :admin) 6. Visit http://localhost:3000/manage and set up the hackathon as needed +### Development Utilities + +- **Mail View** - Email templates can be previewed at http://localhost:3000/rails/mailers +- **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. +- **Guard** - Automatically runs tests based on the files you edit. `bundle exec guard` +- **Coverage** - Test coverage can be manually generated via the `bin/rails coverage:run` command. Results are then made available in the `coverage/` directory. +- **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_). + ## License The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).