Mirrors/go-inbucket
1
0
Fork 0
mirror of https://github.com/jhillyerd/inbucket.git synced 2025-12-17 17:47:03 +00:00
Code Issues Releases Wiki Activity

Updated Development Quickstart (markdown)

James Hillyerd
2020-07-25 12:01:37 -07:00
parent 82cd936036
commit 6663384ea8
1 changed files with 21 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
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
```
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.