diff --git a/Development.md b/Development.md index 3c97274..c1c4ca1 100644 --- a/Development.md +++ b/Development.md @@ -6,8 +6,11 @@ You will need a working Go and Node.js environment. ### Initial build +Checkout the source, and switch to the development branch: + ```sh git clone https://github.com/inbucket/inbucket.git +git checkout develop ``` Build the web UI: @@ -31,4 +34,16 @@ Test Inbucket starts and the web UI loads: ./inbucket ``` -Point your web browser at http://127.0.0.1:9000/ and select the Status tab. \ No newline at end of file +You should see a handful of `INF` log lines. Point your web browser at http://127.0.0.1:9000/ then select the Status tab. If everything loaded, then congratulations, you have a locally compiled build running! + +As we did not pass any specific configuration options to Inbucket, we are using memory storage (instead of files on disk), and it will be empty each time we restart the `inbucket` process. Let's look at a better workflow... + +## Backend development + +### Terminal 1 + +From the root inbucket directory, compile and start inbucket with development config: + +```sh +make +``` \ No newline at end of file