Merge pull request #226 from skycoin/develop

Merge develop to master

Author: gz-c

.travis.yml

@@ -1,12 +1,36 @@
 language: go
 
 go:
-    - 1.8
-    - 1.9
+  - "1.8"
+  - "1.9"
+  - "1.10"
+
+env:
+  - SKYCOIN_ADDR=http://172.17.0.2:6420
+
+services:
+  - docker
+
+addons:
+  apt:
+    sources:
+      - google-chrome
+    packages:
+      - google-chrome-stable
+
+before_install:
+  - nvm install 8.9
 
 install:
   - go get -t ./...
   - make install-linters
+  - npm install
 
 script:
   - make check
+  - make build-ng
+  - make check-ui
+
+notifications:
+  # https://github.com/kvld/travisci-telegram TravisCI Telegram Bot integration
+  webhooks: https://fathomless-fjord-24024.herokuapp.com/notify

CHANGELOG.md

@@ -0,0 +1,18 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
+and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+### Added
+
+- Add support to ARM architecture in Docker Cloud builds
+
+### Fixed
+
+### Changed
+
+### Removed
+

CUSTOMIZATION.md

@@ -6,6 +6,12 @@ The explorer is designed in such a way that it is possible to make simple custom
 
 To simplify copying addresses with mobile devices, the explorer shows qr codes. The qr codes contain the addresses prefixed with the name of the coin, in this way: `skycoin:abcd...` (More information in this link: https://github.com/bitcoin/bips/blob/master/bip-0021.mediawiki). If needed, the `skycoin:` prefix can be changed by modifying the value of `QrConfig.prefix`, inside [app.config.ts](src/app/app.config.ts).
 
+## Search functionality
+
+The explorer is integrated with the browser's search functionality. This means that the user can search for elements of the blockchain directly from the search functionality of the browser. For this to work properly, you must modify the [search.xml](src/search.xml) file. Simply replace the `https://explorer.skycoin.net/` prefix of all URLs with the URL where the browser will reside (it is not necessary to replace the text that may be to the right of that prefix). Also, replace the `ShortName` and `Description` as deemed necessary.
+
+You can find more information about the file format in [opensearch-1-1-draft-6.md](https://github.com/dewitt/opensearch/blob/master/opensearch-1-1-draft-6.md)
+
 ## Colors and general appearance
 
 Most explorer colors and other general UI parameters are defined in [_variables.scss](src/assets/scss/_variables.scss). Making changes to that file is the quickest way to change the explorer appearance.

Makefile

@@ -48,5 +48,29 @@ install-linters: ## Install linters
 format: ## Formats the code. Must have goimports installed (use make install-linters).
 	goimports -w explorer.go
 
+check-ui: ## runs e2e tests connecting to a containerized node
+	go run explorer.go &>/dev/null &
+	sleep 10
+
+	docker volume create skycoin-data
+	docker volume create skycoin-wallet
+	chmod 777 $(PWD)/e2e/test-fixtures/blockchain-180.db
+	
+	docker run -d --rm \
+	-v skycoin-data:/data \
+	-v skycoin-wallet:/wallet \
+	-v $(PWD)/e2e/:/project-root \
+	--name skycoin-backend \
+	-p 6000:6000 \
+	-p 6420:6420 \
+	skycoin/skycoin:develop \
+	-web-interface-addr 172.17.0.2 \
+	-db-path=project-root/test-fixtures/blockchain-180.db \
+	-disable-networking
+
+	npm run e2e-blockchain-180
+
+	docker stop skycoin-backend
+
 help:
 	@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}'

README.md

@@ -6,10 +6,41 @@
 
 https://explorer.skycoin.net
 
+Skycoin Explorer is a tool to interact with Skycoin ecosystem.
+
+You can check blocks, transactions and their states.
+
+[https://explorer.skycoin.net](https://explorer.skycoin.net)
+
+### Quick reference
+
+- **Where to file issues**:
+    [https://github.com/skycoin/skycoin-explorer/issues](https://github.com/skycoin/skycoin-explorer/issues)
+
+# Table of Contents
+
+  - [Releases Notes](CHANGELOG.md)
+  - [Installation](#installation)
+    - [Requirements](#requirements)
+  - [Usage](#usage)
+    - [Run a skycoin node](#run-a-skycoin-node)
+    - [Run the explorer](#run-the-explorer)
+    - [Docker images](#docker-images)
+  - [API documentation](#api-documentation)
+  - [Development](#development)
+    - [Compiling the angular frontend](#compiling-the-angular-frontend)
+    - [Formatting](#formatting)
+    - [Code Linting](#code-linting)
+    - [Customization](#customization)
+  - [Deployment](#deployment)
+
+
+# Installation
+
 ## Requirements
 
 ```
-go>=1.8
+go>=1.10
 node>=v6.9.0
 npm>=3.10.10
 ```
@@ -60,17 +91,9 @@ SKYCOIN_ADDR=http://127.0.0.1:3333 ./explorer
 make run-api
 ```
 
-### Docker images
-
-```
-$ docker build -t skycoin/skycoint-explorer .
-$ docker run -p 8001:8001 skycoin/skycoin-explorer
-```
-
-Access the explorer: [http://localhost:8001](http://localhost:8001).
+## Docker images
 
-The `SKYCOIN_ADDR` and the `EXPLORER_HOST` environment variables can be passed
-to the running container to modify the default behavior.
+If you want to run Explorer on Docker refer to [Docker instructions](docker/images/README.md)
 
 ## API documentation
 

angular.json

@@ -18,7 +18,8 @@
             "polyfills": "src/polyfills.ts",
             "assets": [
               "src/assets",
-              "src/favicon.ico"
+              "src/favicon.ico",
+              "src/search.dev.xml"
             ],
             "styles": [
               "src/assets/css/bootstrap.min.css",
@@ -46,6 +47,11 @@
                   "replace": "src/environments/environment.ts",
                   "with": "src/environments/environment.prod.ts"
                 }
+              ],
+              "assets": [
+                "src/assets",
+                "src/favicon.ico",
+                "src/search.xml"
               ]
             }
           }
@@ -122,6 +128,19 @@
           }
         }
       }
+    },
+    "skycoin-explorer-e2e-blockchain-180": {
+      "root": "",
+      "sourceRoot": "",
+      "projectType": "application",
+      "architect": {
+        "e2e": {
+          "builder": "@angular-devkit/build-angular:protractor",
+          "options": {
+            "protractorConfig": "./protractor-blockchain-180.conf.js"
+          }
+        }
+      }
     }
   },
   "defaultProject": "skycoin-explorer",