Let the user to choose between runing the latest or build from sources

Signed-off-by: David Pordomingo <[email protected]>

Author: dpordomingo

Makefile

@@ -21,6 +21,7 @@ YARN := yarn --cwd $(FRONTEND_PATH)
 REMOVE := rm -rf
 MOVE := mv
 MKDIR := mkdir -p
+COMPOSE_UP := docker-compose
 
 # Default rule
 all:
@@ -68,6 +69,16 @@ build-path:
 
 serve: | front-build back-start
 
+compose-serve: | require-repos-folder front-dependencies build
+	GITBASEPG_REPOS_FOLDER=${GITBASEPG_REPOS_FOLDER} \
+		$(COMPOSE_UP) -f docker-compose.yml -f docker-compose.build.yml up --force-recreate --build
+
+require-repos-folder:
+	@if [[ -z "$(GITBASEPG_REPOS_FOLDER)" ]]; then \
+		echo "error. undefined 'GITBASEPG_REPOS_FOLDER' to be served under gitbase"; \
+		exit 1; \
+	fi
+	$(MKDIR) $(GITBASEPG_REPOS_FOLDER)
 
 # Backend
 

docker-compose.build.yml

@@ -0,0 +1,6 @@
+version: '3.3'
+
+services:
+  playground:
+    image: gitbase-playground-dev
+    build: .

docker-compose.yml

@@ -13,7 +13,7 @@ services:
     environment:
       BBLFSH_ENDPOINT: bblfsh:9432
     volumes:
-      - ${REPOS_FOLDER}:/opt/repos
+      - ${GITBASEPG_REPOS_FOLDER}:/opt/repos
   bblfsh:
     image: "bblfsh/bblfshd"
     privileged: true

docs/quickstart.md

@@ -1,31 +1,65 @@
 # Quickstart
 
-You can locally build and deploy `gitbase-playground` and its dependencies using [`docker-compose`](https://docs.docker.com/compose/install/)
+You can locally build and deploy `gitbase-playground` and its dependencies using [`docker-compose`](https://docs.docker.com/compose/install/).
+Docker compose will run three different containers: for the playground frontend itself, gitbase and bblfsh services. It will be the [latest gitbase version](https://hub.docker.com/r/srcd/gitbase/tags/) and [latest bblfsh version](https://hub.docker.com/r/bblfsh/bblfshd/tags/).
 
 If you preffer to run `gitbase-playground` dependencies manually, you can follow [the alternative playground quickstart](quickstart-manually.md)
 
+
+## Download the project
+
+```bash
+$ git clone [email protected]:src-d/gitbase-playground.git gitbase-playground
+$ cd gitbase-playground
+```
+
+This guide will assume you're running all commands from `gitbase-playground` sources directory
+
+
 ## Populate the database
 
-Populate a directory with some git repositories to be served by [gitbase](https://github.com/src-d/gitbase):
+It is needed to populate a directory with some git repositories to be served by [gitbase](https://github.com/src-d/gitbase) before running it.
+
+example:
 
 ```bash
 $ git clone [email protected]:src-d/gitbase-playground.git ./repos/gitbase-playground
 $ git clone [email protected]:src-d/go-git-fixtures.git ./repos/go-git-fixtures
 ```
 
+Everytime you want to add a new repository to gitbase, the application should be restarted.
+
+
 ## Run the application
 
-Once bblfsh and gitbase are running and accessible, you can serve the playground:
+Run the [latest released version of the frontend](https://hub.docker.com/r/srcd/gitbase-playground/tags/):
 
 ```bash
-$ GITBASEPG_ENV=dev REPOS_FOLDER=./repos GITBASEPG_ENV=dev docker-compose up
+$ GITBASEPG_REPOS_FOLDER=./repos docker-compose up --force-recreate
 ```
 
-Once the server is running –with its default values–, it will be accessible through: http://localhost:8080
+If you want to build and run the playground from sources instead of using the last released version you can do so:
+
+<details>
+<pre>
+$ GITBASEPG_REPOS_FOLDER=./repos make compose-serve
+</pre>
+</details>
+
+## Stop the Application
+
+To kill the running containers just `Ctrl+C`
+
+To delete the containers run `docker-compose rm -f`
 
-You have more information about the [playground architecture](CONTRIBUTING.md#architecture), [development guides](CONTRIBUTING.md#development) and [configuration options](CONTRIBUTING.md#configuration) in the [CONTRIBUTING.md](CONTRIBUTING.md).
 
+## Access to the Playground and Run a Query
 
-## Run a Query
+Once the server is running &ndash;with its default values&ndash;, it will be accessible through: http://localhost:8080
 
 You will find more info about how to run queries using the playground API on the [rest-api guide](rest-api.md)
+
+
+## More Info
+
+You have more information about the [playground architecture](CONTRIBUTING.md#architecture), [development guides](CONTRIBUTING.md#development) and [configuration options](CONTRIBUTING.md#configuration) in the [CONTRIBUTING.md](CONTRIBUTING.md).