From 7b05b54307d1a22100e9da285d6c102b9f79cd4c Mon Sep 17 00:00:00 2001
From: Andrey Antukh <niwi@niwi.nz>
Date: Tue, 1 Mar 2016 19:50:30 +0200
Subject: [PATCH] Update readme.

---
 README.md      | 88 ++++++++++++++++++++++++++++++++------------------
 scripts/docker | 16 +++++++++
 2 files changed, 73 insertions(+), 31 deletions(-)
 create mode 100755 scripts/docker

diff --git a/README.md b/README.md
index d937bbce6..9063be398 100644
--- a/README.md
+++ b/README.md
@@ -3,62 +3,88 @@
 [![Travis Badge](https://img.shields.io/travis/uxbox/uxbox/master.svg)](https://travis-ci.org/uxbox/uxbox "Travis Badge")
 
 
+## Development Environment ##
 
-## Development ##
+### Introduction ###
 
-Grab the code and run:
+The development environment consists in a docker container that mounts your local
+copy of the uxbox souce code directory tree and executes a tmux inside the container
+in order to facilitate execute multiple processes inside.
 
-```
-$ ./scripts/figwheel
+
+### System requirements ###
+
+You should have `docker` installed in your system in order to set up properly
+the uxbox development enviroment.
+
+In debian like linux distributions you can install it executing:
+
+```bash
+sudo apt-get install docker
 ```
 
-This will compile ClojureScript whenever you make changes and serve the application in [localhost](http://localhost:3449/).
-Open the page.
+### Build the docker image ###
 
-### ClojureScript browser-connected REPL ###
+In order to build the docker image, you should clone **uxbox-docker** repository:
 
-The aforementioned command also starts a [nrepl](https://github.com/clojure/tools.nrepl) (network REPL) in the port 7888.
-
-You can connect to it from a shell using the following command:
-
-```
-$ lein repl :connect 7888
+```bash
+git clone git@github.com:uxbox/uxbox-docker.git
 ```
 
-In Emacs you can use [cider's](https://github.com/clojure-emacs/cider) `M-x cider-connect` command and tell it that nREPL is
-running on `localhost:7888` to connect.
+And build the image executing that:
 
-After connecting to nREPL, run the following Clojure code in it:
-
-```
-user> (use 'figwheel-sidecar.repl-api)
-user> (cljs-repl)
+```bash
+cd uxbox-docker
+sudo docker build --rm=true -t uxbox .
 ```
 
-After that, a figwheel message will appear and the prompt will change to `cljs.user>`. We can now evaluate ClojureScript in the
-browser from the REPL.
+### Start the docker image ###
 
+The docker development environment consists in a tmux executed inside the docker
+container giving you the ability to execute multiple processes like one virtual
+machine.
 
-### Static resources generation ###
+**Requires a minimum knowledge of tmux usage in order to use that development
+environment.**
 
-The project's static resources are processed using [gulp](http://gulpjs.com/). First of all, install the npm dependencies running:
+For start it, staying in this repository, execte:
 
-```
-npm install
+```bash
+./scripts/docker
 ```
 
-To start watching the files and process them with each change, run:
+This command will start a new named container, if you stops it and starts again
+the data is conserved because the same container will be resumed again.
 
-```
+
+### First steps inside ###
+
+Now having the the container running and tmux open inside the container, you are
+free to execute any commands and open many shells as you want. The basic frontend
+development requires at least *two shells*.
+
+In the first shell (the defaul one) execute:
+
+```bash
 npm run watch
 ```
 
-To process the resources just once, run:
+That command will launch the gulp process that compiles sass and template file
+and will keep watching for recomplie the sass files when they are changed.
 
-```
-npm run dist
+For create a new shell just press the following key shortcut: **Ctr+b c**.
+
+Once the new shell is created, execute the clojurescript compiler process:
+
+```bash
+npm run figwheel
 ```
 
+You can use **Ctrl+b w** for switch between the existing shells and **Ctrl+b &** for
+kill the current shell.
+
+
+## Other topics ##
 
 ### Transformation from HTML to hiccup ###
 
diff --git a/scripts/docker b/scripts/docker
new file mode 100755
index 000000000..ae233a960
--- /dev/null
+++ b/scripts/docker
@@ -0,0 +1,16 @@
+#!/usr/bin/env bash
+
+if $(sudo docker ps |grep -q "uxbox"); then
+    sudo docker kill uxbox
+fi
+
+if ! $(sudo docker ps |grep -q "uxbox"); then
+    if ! $(sudo docker ps -a |grep -q "uxbox"); then
+        sudo docker run -ti -v `pwd`:/home/uxbox/uxbox \
+             -v $HOME/.m2:/home/uxbox/.m2 -p 3449:3449 \
+             --name uxbox uxbox tmux
+    else
+        sudo docker start uxbox
+        sudo docker attach uxbox
+    fi
+fi