From 860b6c850daf5756ad1f97c111f77e5f21c80df0 Mon Sep 17 00:00:00 2001
From: Nicolai Ort <info@nicolai-ort.com>
Date: Thu, 26 Nov 2020 14:46:52 +0100
Subject: [PATCH] Added differenciation between local and docker based
 testing/dev setup

---
 README.md | 36 ++++++++++++++++++++++++++++++++----
 1 file changed, 32 insertions(+), 4 deletions(-)

diff --git a/README.md b/README.md
index 4a5d479..d667e4b 100644
--- a/README.md
+++ b/README.md
@@ -3,17 +3,45 @@
 Backend Server
 
 ## Dev Setup 🛠
+
+### Local w/ sqlite
+
+1. Create a .env file in the project root containing:
+   ```
+    APP_PORT=4010
+    DB_TYPE=sqlite
+    DB_HOST=bla
+    DB_PORT=bla
+    DB_USER=bla
+    DB_PASSWORD=bla
+    DB_NAME=./test.sqlite
+   ```
+2. Install Dependencies
+   ```bash
+   yarn
+   ```
+3. Start the server
+   ```bash
+   yarn dev
+   ```
+
+### Docker w/ postgres 🐳
+
 ```bash
 docker-compose up --build
 ```
 
 ## Recommended Editor
+
 [Visual Studio Code](https://code.visualstudio.com/)
+
 ### Recommended Extensions
+
 - will be automatically recommended via ./vscode/extensions.json
 
 ## File Structure
-- src/models/* - database models (typeorm entities)
-- src/controllers/* - routing-controllers
-- src/loaders/* - loaders for the different init steps of the api server
-- src/routes/* - express routes for everything we don't do via routing-controllers (shouldn't be much)
\ No newline at end of file
+
+- src/models/\* - database models (typeorm entities)
+- src/controllers/\* - routing-controllers
+- src/loaders/\* - loaders for the different init steps of the api server
+- src/routes/\* - express routes for everything we don't do via routing-controllers (shouldn't be much)