Added basic readme

2021-08-14 09:40:07 +02:00 · 2021-08-14 09:40:07 +02:00 · 1c2c1dbbbb
parent 9c23404210
commit 1c2c1dbbbb
1 changed files with 26 additions and 0 deletions
--- a/README.md
+++ b/README.md
@ -0,0 +1,26 @@
+# Unnamed Urlshortener 🔗
+> This - yet to be named - project is a small url shortener, originaly developed for kauft.es
+
+## Dev Setup 🛠
+> Runs on port 3000
+
+#### Yarn
+```bash
+yarn
+yarn migrate
+yarn dev
+```
+
+#### NPM
+```bash
+npm i
+npm run migrate
+npm run dev
+```
+
+## Docker 🐳
+> Runs on port 3000
+```
+docker-compose build
+docker-compose up
+```