diff --git a/Development-Quickstart.md b/Development-Quickstart.md index bd3b5a1..35b761a 100644 --- a/Development-Quickstart.md +++ b/Development-Quickstart.md @@ -8,33 +8,34 @@ Checkout the source, and switch to the development branch: ```sh git clone https://github.com/inbucket/inbucket.git +cd inbucket git checkout develop ``` -Build the web UI: +Build the backend (will fetch Go dependencies): ```sh -cd inbucket/ui +make +``` + +Install JavaScript dependencies and build the web UI: + +```sh +cd ui npm i npm run build ``` -Build the backend: +Verify Inbucket starts and that the web UI loads: ```sh cd .. -make -``` - -Test Inbucket starts and the web UI loads: - -```sh ./inbucket ``` -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! +You should see a handful of `INF` log lines but no errors. 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... +As we did not pass any specific configuration options to Inbucket, it is using memory storage (instead of files on disk), and will be empty each time we restart the `inbucket` process. Let's look at a better workflow... # Backend development