Custom Analytics Dashboard for Microsoft Bot Framework and other applications as well
Перейти к файлу
Mor Shemesh a2222b503a Merge pull request #247 from CatalystCode/ibex-version-1.0
Ibex version 1.0
2017-07-30 10:08:49 +03:00
.travis Make build.sh executable 2017-07-12 15:04:50 +01:00
.vscode removing yarn and updating to npm v 5.0.0 2017-06-06 17:19:18 +03:00
build Travis build: 331 2017-07-23 14:26:03 +00:00
client fixing api for PR 2017-07-23 12:50:53 +03:00
docs Docs formatting 2017-06-24 12:25:49 +01:00
scripts/deployment Merge pull request #222 from CatalystCode/master 2017-07-03 15:50:27 +03:00
server fixing api for PR 2017-07-23 12:50:53 +03:00
src Merge branch 'issue_66_Enable_dashboards_deletion_API_UX' into itye/ibex-version-1.0-deletion-merge 2017-07-03 16:20:48 +03:00
.deployment install in production with yarn 2017-06-07 17:43:47 +03:00
.editorconfig Split panel dialog with errors groups 2017-04-07 19:59:51 +01:00
.gitignore merge of client - server seperation with ibex-version-1.0 2017-06-28 19:48:23 +03:00
.travis.yml removing uneeded permissions change 2017-07-12 15:05:41 +01:00
Dockerfile Update Dockerfile 2017-07-02 09:32:46 +03:00
README.md update build badge 2017-07-12 14:59:31 +01:00
package-lock.json Fix Query Tester in AI Connection Settings 2017-06-27 10:15:30 +03:00
package.json update build process 2017-07-11 17:47:32 +01:00
yarn.lock adding base package.json to root 2017-06-29 16:25:09 +03:00

README.md

Ibex Dashboard Build Status

This is an application insights based project that displays a bots analytics dashboard.

Preview

Preview Preview

Show With Your Own Data

  1. Clone

  2. Get an Application Insights App ID and Api Key

  3. Run cd server; yarn start

  4. Run cd client; yarn start

  5. Open http://localhost:3000/

  6. Run through setup and afterwards, fill in API Key and Application ID

Deploy To Azure

There are 3 ways to deploy to Azure:

1. Web App - Automated

  1. Fork this repo (to be able to automatically create github deployment key)
  2. After fork, copy the fork url and use it with the following deployment button:

2. Web App On Linux - Automated with Docker Hub

3. Manual

  1. Fork this repo (to be able to automatically create github deployment key)
  2. Clone & Deploy:
  3. Create a new Web App in Azure

Important Note

Since application insights API doesn't support ARM yet, we need to manually create an API Key for the application insights service. Once you created the api key, copy and paste it into the Dashboard settings screen.

Deploy With Docker

  1. docker build -t **image name** .
  2. docker run -d -e PORT=80 **image name**
  3. Docker image is also available at Docker Hub - docker pull catalystcode/ibex-dashboard

Create new API Key and Application ID

The following steps explain how to connect Application Insights bot with your bot and your dashboard: [you can also follow the official Application Insights article].

  1. Go to azure portal
  2. Select: Resource Groups > [new resource group] > App Insights Service
  3. Copy Instrumentation Key and paste into your bot registration page (on the bottom)
  4. Click: API Access > Create New Key > + Read Telemetry
  5. Copy Application ID + API Key
  6. Open the URL of your web app
  7. Under AppId/ApiKey set the values you created.

Resources

Technologies In Use

Resources

This project is built using:

The server approach was added using:

Thinking about integrating with:

Assumptions

  1. Running node version 6.11 or above.

Installation

git clone https://github.com/CatalystCode/ibex-dashboard.git
cd ibex-dashboard
(cd client; npm install -g yarn; yarn)
(cd server; npm install -g yarn; yarn)

Dev

(cd server; yarn start:dev)
(cd client; yarn start:dev)

Test Watcher

Runs the test watcher in an interactive mode. By default, runs tests related to files changes since the last commit.

cd client
yarn test

Alternatively, you can also run the full commands that the Travis CI server will run to validate any changes.

.travis/ci.sh

Build for Production

Our CI server Travis creates new production builds automatically for changes to master. If you need to create a build locally, you can execute the same commands as the CI server.

.travis/build.sh

Whats Inside?