From b6550851154301559fab003418c9d45823c145e9 Mon Sep 17 00:00:00 2001
From: Dragory <2606411+Dragory@users.noreply.github.com>
Date: Sun, 26 Jun 2022 15:31:20 +0300
Subject: [PATCH] Add quick instructions for docker dev environment

---
 docker/development/README.md | 27 +++++++++++++++++++++++++++
 1 file changed, 27 insertions(+)
 create mode 100644 docker/development/README.md

diff --git a/docker/development/README.md b/docker/development/README.md
new file mode 100644
index 00000000..2605b108
--- /dev/null
+++ b/docker/development/README.md
@@ -0,0 +1,27 @@
+# Running the development environment
+1. Install Docker
+2. Fill the values in .env
+3. Run `./docker-compose-dev.sh up` to start the development environment
+4. Connect to the development environment with your editor's remote SSH feature (see below)
+
+## Connecting with VSCode
+1. Install the `Remote - SSH` plugin
+2. Run `Remote-SSH: Connect to Host...`
+    * As the address, use `ubuntu@127.0.0.1:3002` where `3002` matches `DOCKER_DEV_SSH_PORT` in `.env`
+    * Use the password specified in `.env` as `DOCKER_DEV_SSH_PASSWORD`
+3. Once connected, click `Open folder...` and select `/home/ubuntu/zeppelin`
+
+## Connecting with JetBrains Gateway
+* TODO (basically the same as VSCode instructions though)
+
+## Starting the backend (bot + api)
+These commands are run inside the dev container. You should be able to just open a terminal in your editor after connecting.
+1. `cd ~/zeppelin/backend`
+2. `npm ci`
+3. `npm run migrate-dev`
+4. `npm run watch`
+
+## Starting the dashboard
+1. `cd ~/zeppelin/dashboard`
+2. `npm ci`
+3. `npm run watch-build`