From 6663384ea84210c3a16ae724eb1de4091917b70d Mon Sep 17 00:00:00 2001 From: James Hillyerd Date: Sat, 25 Jul 2020 12:01:37 -0700 Subject: [PATCH] Updated Development Quickstart (markdown) --- Development-Quickstart.md | 23 +++++++++++++++++++++-- 1 file changed, 21 insertions(+), 2 deletions(-) diff --git a/Development-Quickstart.md b/Development-Quickstart.md index 35b761a..c1fc06d 100644 --- a/Development-Quickstart.md +++ b/Development-Quickstart.md @@ -1,6 +1,8 @@ # Development Quickstart -You will need a working Go and Node.js environment. +You will need a working Go and Node.js environment. Installing [Swaks](http://www.jetmore.org/john/code/swaks/) is recommended to generate test mail. + +_Note:_ While it is possible to develop on Windows, Linux or Mac OS is required to use most of our helper scripts. ## Initial build @@ -45,4 +47,21 @@ From the root inbucket directory, compile and start inbucket with development co ```sh make -``` \ No newline at end of file +etc/dev-start.sh +``` + +_Note:_ The dev script will abort if the web UI index.html file is not found. + +This will launch Inbucket with a development friendly configuration with debug logging and storing mail in /tmp/inbucket. The retention period is reduced to 3 hours to encourage you to send in fresh mail periodically. + +Point your web browser at http://127.0.0.1:9000/ then select the Monitor tab. + +## Terminal 2 + +Send some test messages (requires Swaks to be installed): + +```sh +etc/swaks-tests/run-tests.sh +``` + +You should see the emails listed in your web browser, as well as a bunch of Inbucket debug logging in Terminal 1.