Merge pull request #220 from carlosms/rename-web-ui

Rename playground to web in the UI and docs

Author: carlosms

.github/screenshot.png

@@ -1,17 +1,17 @@
-[![Build Status](https://travis-ci.org/src-d/gitbase-playground.svg)](https://travis-ci.org/src-d/gitbase-playground)
-[![codecov.io](https://codecov.io/github/src-d/gitbase-playground/coverage.svg)](https://codecov.io/github/src-d/gitbase-playground)
+[![Build Status](https://travis-ci.org/src-d/gitbase-web.svg)](https://travis-ci.org/src-d/gitbase-web)
+[![codecov.io](https://codecov.io/github/src-d/gitbase-web/coverage.svg)](https://codecov.io/github/src-d/gitbase-web)
 
-# Gitbase Playground
+# Gitbase Web
 
-Web application to query Git repositories using SQL. Powered by [gitbase](https://github.com/src-d/gitbase), it allows to perform SQL queries on the Git history and the [Universal AST](https://doc.bblf.sh/) of the code itself.
+Application to query Git repositories using SQL. Powered by [gitbase](https://github.com/src-d/gitbase), it allows to perform SQL queries on the Git history and the [Universal AST](https://doc.bblf.sh/) of the code itself.
 
 ![Screenshot](.github/screenshot.png?raw=true)
 
 # Usage
 
 ## With Docker Compose
 
-The easiest way to run Gitbase Playground and its dependencies is using [Docker Compose](https://docs.docker.com/compose/install/).
+The easiest way to run Gitbase Web and its dependencies is using [Docker Compose](https://docs.docker.com/compose/install/).
 
 The first step is to populate a directory with some Git repositories to be served by gitbase before running it. For example:
 
@@ -20,13 +20,13 @@ $ mkdir $HOME/repos
 $ cd $HOME/repos
 $ git clone [email protected]:src-d/gitbase.git
 $ git clone [email protected]:bblfsh/bblfshd.git
-$ git clone [email protected]:src-d/gitbase-playground.git
+$ git clone [email protected]:src-d/gitbase-web.git
 ```
 
-Next you will need to download the `docker-compose.yml` file from this repository and run `docker-compose`. This tool will run three different containers: the playground frontend itself, gitbase, and bblfshd. To kill the running containers use `Ctrl+C`.
+Next you will need to download the `docker-compose.yml` file from this repository and run `docker-compose`. This tool will run three different containers: the gitbase-web frontend itself, gitbase, and bblfshd. To kill the running containers use `Ctrl+C`.
 
 ```bash
-$ wget https://raw.githubusercontent.com/src-d/gitbase-playground/master/docker-compose.yml
+$ wget https://raw.githubusercontent.com/src-d/gitbase-web/master/docker-compose.yml
 $ docker-compose pull
 $ GITBASEPG_REPOS_FOLDER=$HOME/repos docker-compose up --force-recreate
 ```
@@ -41,29 +41,29 @@ for cleanup.
 
 ## Without Docker Compose
 
-The playground will run the queries against a [gitbase](https://docs.sourced.tech/gitbase) server, and will request UASTs to a [bblfsh](https://doc.bblf.sh/) server. Make sure both are properly configured.
+The application will run the queries against a [gitbase](https://docs.sourced.tech/gitbase) server, and will request UASTs to a [bblfsh](https://doc.bblf.sh/) server. Make sure both are properly configured.
 
-Then you can choose to run the Gitbase Playground either as a docker container, or as a binary.
+Then you can choose to run the web client either as a docker container, or as a binary.
 
 ### As a Docker
 
 ```bash
-$ docker pull srcd/gitbase-playground:latest
+$ docker pull srcd/gitbase-web:latest
 $ docker run -d \
     --publish 8080:8080 \
     --env GITBASEPG_DB_CONNECTION="root@tcp(<gitbase-ip>:3306)/none" \
     --env GITBASEPG_BBLFSH_SERVER_URL="<bblfshd-ip>:9432" \
-    srcd/gitbase-playground:latest
+    srcd/gitbase-web:latest
 ```
 
 ### As a Binary
 
-Download the binary from our [releases section](https://github.com/src-d/gitbase-playground/releases), and run it:
+Download the binary from our [releases section](https://github.com/src-d/gitbase-web/releases), and run it:
 
 ```bash
 $ export GITBASEPG_DB_CONNECTION="root@tcp(<gitbase-ip>:3306)/none"
 $ export GITBASEPG_BBLFSH_SERVER_URL="<bblfshd-ip>:9432"
-$ ./gitbase-playground
+$ ./gitbase-web
 ```
 
 # Configuration
@@ -83,7 +83,7 @@ Any of the previous execution methods accept configuration through the following
 
 # Contribute
 
-[Contributions](https://github.com/src-d/gitbase-playground/issues) are more than welcome, if you are interested please take a look to our [Contributing Guidelines](docs/CONTRIBUTING.md). There you will also find information on how to build and run the project from sources.
+[Contributions](https://github.com/src-d/gitbase-web/issues) are more than welcome, if you are interested please take a look to our [Contributing Guidelines](docs/CONTRIBUTING.md). There you will also find information on how to build and run the project from sources.
 
 # Code of Conduct
 

README.md

@@ -1,4 +1,4 @@
-# Gitbase Playground Contribution Guidelines
+# Gitbase Web Contribution Guidelines
 
 As all source{d} projects, this project follows the
 [source{d} Contributing Guidelines](https://github.com/src-d/guide/blob/master/engineering/documents/CONTRIBUTING.md).
@@ -11,7 +11,7 @@ Refer to the main [README](../README.md) for the common requirements and configu
 
 Make sure you also satisfy these requirements:
 - [Install Go](https://golang.org/doc/install) and [configure the $GOPATH](https://github.com/golang/go/wiki/SettingGOPATH).
-- This project should be cloned in `$GOPATH/github.com/src-d/gitbase-playground`.
+- This project should be cloned in `$GOPATH/github.com/src-d/gitbase-web`.
 - Install [Node.js](https://nodejs.org) and [Yarn](https://yarnpkg.com/en/docs/install).
 
 ## Run bblfsh and gitbase Dependencies
@@ -37,7 +37,7 @@ $ mkdir $HOME/repos
 $ cd $HOME/repos
 $ git clone [email protected]:src-d/gitbase.git
 $ git clone [email protected]:bblfsh/bblfshd.git
-$ git clone [email protected]:src-d/gitbase-playground.git
+$ git clone [email protected]:src-d/gitbase-web.git
 ```
 
 Launch gitbase:
@@ -69,8 +69,8 @@ Each one of the following sections describes an alternative method to run the pr
 They all require the project is cloned into your `$GOPATH`.
 
 ```bash
-$ go get -d -u github.com/src-d/gitbase-playground/...
-$ cd $GOPATH/github.com/src-d/gitbase-playground
+$ go get -d -u github.com/src-d/gitbase-web/...
+$ cd $GOPATH/github.com/src-d/gitbase-web
 ```
 
 ## Run from Sources
@@ -90,7 +90,7 @@ Instead of rebuilding the frontend and restarting the backend every time you do
 In one terminal run the Go backend:
 
 ```bash
-$ GITBASEPG_ENV=dev go run cmd/gitbase-playground/main.go
+$ GITBASEPG_ENV=dev go run cmd/gitbase-web/main.go
 ```
 
 In another terminal, run the frontend:
@@ -101,7 +101,7 @@ $ yarn --cwd frontend start
 
 ## Run with Docker Compose from Sources
 
-The file `docker-compose.build.yml` overrides the default compose file. Using it a new docker image, `gitbase-playground-dev`, will be created from the current sources.
+The file `docker-compose.build.yml` overrides the default compose file. Using it a new docker image, `gitbase-web-dev`, will be created from the current sources.
 
 ```bash
 $ make dependencies
@@ -151,7 +151,7 @@ Use the `GITBASEPG_INTEGRATION_TESTS=true` environment variable with the same `m
 
 The integration tests require that `gitbase` and `bblfshd` are running and reachable. See the [Requirements section](#requirements) above for more details.
 
-It is also required to configure the running `gitbase` to serve a copy of the `https://github.com/src-d/gitbase-playground` repository.
+It is also required to configure the running `gitbase` to serve a copy of the `https://github.com/src-d/gitbase-web` repository.
 
 ```bash
 $ GITBASEPG_INTEGRATION_TESTS=true make test

docs/CONTRIBUTING.md

@@ -151,7 +151,7 @@ curl -X POST \
     "status": 200,
     "data": [
         {
-            "content": "package server\n\nimport (\n\t\"net/http\"\n\n\t\"github.com/src-d/gitbase-playground/server/handler\"\n\n\t\"github.com/go-chi/chi\"\n\t\"github.com/go-chi/chi/middleware\"\n\t\"github.com/pressly/lg\"\n\t\"github.com/rs/cors\"\n\t\"github.com/sirupsen/logrus\"\n)\n\n// Router returns a Handler to serve the backend\nfunc Router(\n\tlogger *logrus.Logger,\n\tstatic *handler.Static,\n\tversion string,\n) http.Handler {\n\n\t// cors options\n\tcorsOptions := cors.Options{\n\t\tAllowedOrigins:   []string{\"*\"},\n\t\tAllowedMethods:   []string{\"GET\", \"POST\", \"PUT\", \"OPTIONS\"},\n\t\tAllowedHeaders:   []string{\"Location\", \"Authorization\", \"Content-Type\"},\n\t\tAllowCredentials: true,\n\t}\n\n\tr := chi.NewRouter()\n\n\tr.Use(middleware.Recoverer)\n\tr.Use(cors.New(corsOptions).Handler)\n\tr.Use(lg.RequestLogger(logger))\n\n\tr.Get(\"/version\", handler.APIHandlerFunc(handler.Version(version)))\n\n\tr.Get(\"/static/*\", static.ServeHTTP)\n\tr.Get(\"/*\", static.ServeHTTP)\n\n\treturn r\n}\n",
+            "content": "package server\n\nimport (\n\t\"net/http\"\n\n\t\"github.com/src-d/gitbase-web/server/handler\"\n\n\t\"github.com/go-chi/chi\"\n\t\"github.com/go-chi/chi/middleware\"\n\t\"github.com/pressly/lg\"\n\t\"github.com/rs/cors\"\n\t\"github.com/sirupsen/logrus\"\n)\n\n// Router returns a Handler to serve the backend\nfunc Router(\n\tlogger *logrus.Logger,\n\tstatic *handler.Static,\n\tversion string,\n) http.Handler {\n\n\t// cors options\n\tcorsOptions := cors.Options{\n\t\tAllowedOrigins:   []string{\"*\"},\n\t\tAllowedMethods:   []string{\"GET\", \"POST\", \"PUT\", \"OPTIONS\"},\n\t\tAllowedHeaders:   []string{\"Location\", \"Authorization\", \"Content-Type\"},\n\t\tAllowCredentials: true,\n\t}\n\n\tr := chi.NewRouter()\n\n\tr.Use(middleware.Recoverer)\n\tr.Use(cors.New(corsOptions).Handler)\n\tr.Use(lg.RequestLogger(logger))\n\n\tr.Get(\"/version\", handler.APIHandlerFunc(handler.Version(version)))\n\n\tr.Get(\"/static/*\", static.ServeHTTP)\n\tr.Get(\"/*\", static.ServeHTTP)\n\n\treturn r\n}\n",
             "hash": "fd30cea52792da5ece9156eea4022bdd87565633",
             "uast(blobs.content, \"go\")": [
                 {
@@ -259,7 +259,7 @@ curl -X GET http://localhost:8080/export?query=select+*+from+repositories
 
 ```json
 id
-/opt/repos/gitbase-playground
+/opt/repos/gitbase-web
 /opt/repos/go-git-fixtures
 ```
 

docs/rest-api.md

@@ -19,7 +19,7 @@
       work correctly both with client-side routing and a non-root public URL.
       Learn how to configure a non-root public URL by running `npm run build`.
     -->
-    <title>Gitbase Playground</title>
+    <title>Gitbase Web</title>
   </head>
   <body>
     <noscript>

frontend/public/index.html

@@ -1,6 +1,6 @@
 {
-  "short_name": "Gitbase Playground",
-  "name": "Gitbase Playground",
+  "short_name": "Gitbase Web",
+  "name": "Gitbase Web",
   "icons": [
     {
       "src": "favicon.ico",

frontend/public/manifest.json

@@ -408,7 +408,7 @@ AND refs.ref_name = 'HEAD'`
     return (
       <div className="app">
         <Helmet>
-          <title>Gitbase Playground</title>
+          <title>Gitbase Web</title>
         </Helmet>
         <Grid className="full-height app-grid" fluid={true}>
           <Row className="main-row full-height">

frontend/src/App.js

@@ -38,7 +38,7 @@ class Sidebar extends Component {
     return (
       <div className={`sidebar ${collapsed ? 'collapsed' : ''}`}>
         <div className="header">
-          <h3>gitbase playgroun{'{d}'}</h3>
+          <h3>gitbase web</h3>
           <CollapseIcon className="big-icon" onClick={this.handleToggle} />
         </div>
         <div className="main">