From 4010140bf9387d20d9b84100d0d80202793ca745 Mon Sep 17 00:00:00 2001 From: James Hillyerd Date: Sat, 25 Jul 2020 11:23:49 -0700 Subject: [PATCH] Created Development (markdown) --- Development.md | 34 ++++++++++++++++++++++++++++++++++ 1 file changed, 34 insertions(+) create mode 100644 Development.md diff --git a/Development.md b/Development.md new file mode 100644 index 0000000..3c97274 --- /dev/null +++ b/Development.md @@ -0,0 +1,34 @@ +# Development + +## Quickstart + +You will need a working Go and Node.js environment. + +### Initial build + +```sh +git clone https://github.com/inbucket/inbucket.git +``` + +Build the web UI: + +```sh +cd inbucket/ui +npm i +npm run build +``` + +Build the backend: + +```sh +cd .. +make +``` + +Test Inbucket starts and the web UI loads: + +```sh +./inbucket +``` + +Point your web browser at http://127.0.0.1:9000/ and select the Status tab. \ No newline at end of file