From b543475d48e99ca0558c0d630912ca2643d8ebcc Mon Sep 17 00:00:00 2001 From: Nicco Date: Thu, 23 May 2019 13:06:03 +0200 Subject: [PATCH 1/3] Update README.md --- README.md | 21 ++++++++++++++++++++- 1 file changed, 20 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index b8cb060..5930219 100644 --- a/README.md +++ b/README.md @@ -1 +1,20 @@ -# obolus 💰 \ No newline at end of file +# 💰obolus + +## 🛠development + +```bash +// Clone +git clone https://github.com/CupCakeArmy/obolus.git +cd obolus + +// Local +npm run dev:local + +// With docker +npm run dev:docker +``` + +### 🗒notes + +- All code is hot-reloaded. +- When switching from `local` to `docker` please run `npm run clean` as the `sqlite3` package needs to download the right binaries for the current maschine. From 649997c1fbbcfcd631290bb73c9110990d1a074b Mon Sep 17 00:00:00 2001 From: Nicco Date: Thu, 23 May 2019 13:06:35 +0200 Subject: [PATCH 2/3] Update README.md --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 5930219..a1d2825 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ -# 💰obolus +# obolus 💰 -## 🛠development +## development 🛠 ```bash // Clone @@ -14,7 +14,7 @@ npm run dev:local npm run dev:docker ``` -### 🗒notes +### notes 🗒 - All code is hot-reloaded. - When switching from `local` to `docker` please run `npm run clean` as the `sqlite3` package needs to download the right binaries for the current maschine. From 595bb531d1aeda0ab1d7e936ac835833031344f3 Mon Sep 17 00:00:00 2001 From: Nicco Date: Thu, 23 May 2019 13:08:14 +0200 Subject: [PATCH 3/3] Update README.md --- README.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index a1d2825..ed5c8d8 100644 --- a/README.md +++ b/README.md @@ -3,18 +3,21 @@ ## development 🛠 ```bash -// Clone +// clone git clone https://github.com/CupCakeArmy/obolus.git cd obolus -// Local +// local npm run dev:local -// With docker +// or with docker npm run dev:docker + +// -> http://localhost 🚀 ``` ### notes 🗒 +- The first run will take 1-2 minutes before you can see anything as modules needs to be installed and the code compiled. - All code is hot-reloaded. - When switching from `local` to `docker` please run `npm run clean` as the `sqlite3` package needs to download the right binaries for the current maschine.