Merge "[CE-33] add document and Dockerfile for user dashboard"

hyperledger · Jun 9, 2017 · ec42e69 · ec42e69
2 parents 0d6bb37 + e11a7cc
commit ec42e69
Show file tree

Hide file tree

Showing 7 changed files with 136 additions and 2 deletions.
diff --git a/user-dashboard/Dockerfile b/user-dashboard/Dockerfile
@@ -0,0 +1,10 @@
+FROM node
+MAINTAINER li xu cheng "lixucheng@aliyun.com"
+RUN npm install -g requirejs
+RUN mkdir -p /usr/app/src
+COPY . /usr/app/src
+RUN r.js -o /usr/app/src/build.js
+WORKDIR /usr/app/built
+RUN npm install && npm cache clean
+EXPOSE 8080
+CMD ["npm", "start"]
diff --git a/user-dashboard/build.js b/user-dashboard/build.js
@@ -0,0 +1,68 @@
+/**
+ * Created by lixuc on 2017/5/19.
+ */
+({
+    appDir: "./",
+    baseUrl: "./public/js",
+    mainConfigFile: "./public/js/common.js",
+    dir: "../built",
+    fileExclusionRegExp: /^node_modules|.idea|build\.js|\.DS_Store|Dockerfile|docker-compose\.yml/,
+    skipDirOptimize: true,
+    preserveLicenseComments: false,
+    modules:[
+        {
+            name: "common",
+            include: [
+                "jquery",
+                "uikit",
+                "lodash",
+                "plugin/notify",
+                "plugin/tooltip"
+            ]
+        },
+        {
+            name: "app/index",
+            exclude: ["common"]
+        },
+        {
+            name: "app/dashboard/home",
+            exclude: ["common"]
+        },
+        {
+            name: "app/dashboard/chain/list",
+            exclude: ["common"]
+        },
+        {
+            name: "app/dashboard/chain/detail",
+            exclude: ["common"]
+        },
+        {
+            name: "app/dashboard/contract/list",
+            exclude: ["common"]
+        },
+        {
+            name: "app/dashboard/analytics/nochains",
+            exclude: ["common"]
+        },
+        {
+            name: "app/dashboard/analytics/overview",
+            exclude: ["common"]
+        },
+        {
+            name: "app/dashboard/analytics/chaincode/list",
+            exclude: ["common"]
+        },
+        {
+            name: "app/dashboard/analytics/fabric",
+            exclude: ["common"]
+        },
+        {
+            name: "app/dashboard/analytics/infrastructure",
+            exclude: ["common"]
+        },
+        {
+            name: "app/dashboard/store",
+            exclude: ["common"]
+        }
+    ]
+})
diff --git a/user-dashboard/docker-compose.yml b/user-dashboard/docker-compose.yml
@@ -0,0 +1,15 @@
+version: "2"
+services:
+  dashboard:
+    build: ./
+    image: cello-user-dashboard
+    container_name: user-dashboard
+    links:
+      - mongodb:dashboard_mongo
+    ports:
+      - "8080:8080"
+  mongodb:
+    image: mongo
+    container_name: mongo
+    ports:
+      - "27017:27017"
diff --git a/user-dashboard/docs/README.md b/user-dashboard/docs/README.md
@@ -0,0 +1,40 @@
+# User Dashboard for Blockchain
+
+This dashboard is a web based application for blockchain developers. It is especially useful for blockchain apps incubation. You can upload your smart contract, apply one or more chains that deploy your smart contract, and invoke / query your smart contract functions on the dashboard. It include blockchain topology overview, network latency monitor and log tracking, blocks' transactions reveal and etc. Also support chaincode, fabric and infrastructure analytics.
+
+![Dashboard home page](images/dashboard-home.png)
+
+## Installation
+
+1. Goto directory of user dashboard
+
+	```
+	$ cd my-local-cello-dir/user-dashboard
+	```
+
+2. Build dashboard image
+
+	```
+	$ docker-compose build
+	```
+
+3. Start dashboard
+
+	```
+	$ docker-compose up -d
+	```
+
+4. Access url:  [http://localhost:8080](http://localhost:8080)
+
+## Functions
+
+| Name | URL | Description |
+| --- | --- | --- |
+| Home | `/dashboard` | The dashboard overview |
+| Chain Management | `/dashboard/chain` | Include functions of apply / edit / release / start / stop / restart chains |
+| Chain Detail | `/dashboard/chain/{id}` | Include functions of topology overview, log tracking, blocks view, APIs exposure and chaincode list / invoke / query |
+| Smart Contract Management | `/dashboard/contract` | Include functions of smart contract upload, edit, delete and deploy |
+| Analytics Overview | `/dashboard/analytics` | The high-level overview of chain status |
+| Chaincode Analytics | `/dashboard/analytics/chaincode` | Chaincode invoke functions and response time statistic analysis |
+| Fabric Analytics | `/dashboard/analytics/fabric` | Blocks amount and block time statistic analysis |
+| Infrastructure Analytics | `/dashboard/analytics/infrastructure` | Cluster's CPU, memory, disk and network statistic analysis |
diff --git a/user-dashboard/docs/images/dashboard-home.png b/user-dashboard/docs/images/dashboard-home.png
diff --git a/user-dashboard/modules/configuration.js b/user-dashboard/modules/configuration.js
@@ -11,10 +11,10 @@ module.exports = {
     Log_Server: process.env.Log_Server || "9.186.91.29:8080",
     Log_BaseURL: "/v1/log",
     mongodb: {
-        ip: "127.0.0.1",
+        ip: "dashboard_mongo",
         port: 27017,
         name: "bc_dashboard",
-        auth: true,
+        auth: false,
         username: "admin",
         password: "passw0rd"
     },

diff --git a/user-dashboard/package.json b/user-dashboard/package.json
@@ -19,6 +19,7 @@
   },
   "devDependencies": {},
   "scripts": {
+    "start": "node app.js",
     "test": "echo \"Error: no test specified\" && exit 1"
   },
   "author": "li xu cheng",