diff --git a/README.md b/README.md new file mode 100644 index 0000000..1afdfce --- /dev/null +++ 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 +``` \ No newline at end of file