From 32636d48d2c267988e64341139e4a03cf9ae1509 Mon Sep 17 00:00:00 2001
From: Jrester <jrester379@gmail.com>
Date: Tue, 31 Mar 2020 11:31:32 +0200
Subject: [PATCH] Add development instruction to README

	modified:   README.md
---
 README.md | 32 ++++++++++++++++++++++++++++++++
 1 file changed, 32 insertions(+)

diff --git a/README.md b/README.md
index e42f98a..b8904e5 100644
--- a/README.md
+++ b/README.md
@@ -140,6 +140,38 @@ Feel free to modify this file in order to use your existing keys
  * Join us on [Discord](https://discord.gg/fjx7gGJ)
  * Create an issue
 
+## Development
+
+### Backend
+
+From the top level directory run
+
+```
+$ go run main.go
+```
+
+### Frontend
+
+Inside another terminal session navigate into the `ui` folder
+
+```
+$ cd ui
+```
+Install required dependencies
+```
+$ npm install
+```
+Set the base url for the api
+```
+$ export VUE_APP_API_BASE_URL=http://localhost:8080/api/v1.0
+```
+Start the development server. It will rebuild and reload the site once you make a change to the source code.
+```
+$ npm run serve
+```
+
+Now you can access the site from a webbrowser with the url `http://localhost:8081`.
+
 ## Application stack
 
  * [Gin, HTTP web framework written in Go](https://github.com/gin-gonic/gin)
-- 
GitLab