From 73a738b0ae6f5f13cfbdcda75c0c914f5856bf12 Mon Sep 17 00:00:00 2001
From: Kevin <Kevin.Midboe@gmail.com>
Date: Sun, 11 Dec 2022 18:33:31 +0100
Subject: [PATCH] Create README.md

---
 README.md | 52 ++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 52 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..da94780
--- /dev/null
+++ b/README.md
@@ -0,0 +1,52 @@
+# planetposen backend
+
+Backend api of planetposen webshop. View frontend at: [kevinmidboe/planetposen-frontend](https://github.com/kevinmidboe/planetposen-frontend)
+
+Also uses the following supplementary go apps:
+ - image proxy  : [kevinmidboe/planetposen-images](https://github.com/kevinmidboe/planetposen-image)
+ - email sender : [kevinmidboe/planetposen-mail](https://github.com/kevinmidboe/planetposen-mail)
+
+## Install
+
+Download project:
+
+```bash
+git clone https://github.com/kevinmidboe/planetposen-backend
+cd planetposen-backend
+```
+
+Install dependencies:
+```bash
+yarn
+```
+
+or
+
+```bash
+npm install
+```
+
+Copy default configuration files:
+```bash
+cp config/default/* config/env
+```
+
+Update values in configuration files for both development & production
+
+## Build
+To compile typescript files to javascript build project by running:
+
+```bash
+yarn build:ts
+```
+
+## Developing
+
+Start application with development configuration:
+
+```bash
+yarn dev
+```
+
+Api will be available at: http://localhost:30010
+