Skip to content

Latest commit

 

History

History
142 lines (88 loc) · 7.94 KB

README.md

File metadata and controls

142 lines (88 loc) · 7.94 KB
Raw

NGX Dynamic Dashboard Framework

Natural Language Processing (NLP) integration

Image of Main Screen

Sample Board 1

Image of Main Screen

Add Board and Gadget

Image of Add Gadget To Screen

Layout

Image Layout

Alert/Notification

Image Notification

Sample Realtime Web Socket Based Gadget

Image of Add Gadget To Screen

Sample Board 2

Image of Main Screen

Drag and Drop

Image of Add Board To Screen

Facet Filter

Image of Filter Board To Screen

Note: This project is under heavy construction and is not intended for general production use yet. As such, we are not accepting bugs at the moment and documentation is quite lacking.

This is an angular (ngx) based dashboard framework that is inspired by JIRA's dashboard implementation and https://github.com/angular-dashboard-framework/angular-dashboard-framework

The primary projects leveraged:

  • Angular - https://angularjs.org/
  • ngx-charts (angular based d3 charts) - https://github.com/swimlane/ngx-charts
  • Semantic-UI - https://semantic-ui.com/
  • ng2-dnd drag and drop - https://github.com/akserg/ng2-dnd
  • AI Natural Language Processing - The board includes two options for AI, Wit.Ai and IBM Watson.
  • Wit.ai - Natural Language Processing site has been integrated via JSONP
  • IBM Watson - IBM Watson does not support JSONP so the code relies on a backend implementation of the IBM Watson SDK. I offer sample backend code based on Spring Boot within the comments of the Runtime Service

Features:

  • Leverages Angular's dynamic data driven forms approach for gadget property pages and properties - https://angular.io/guide/dynamic-form
  • Dynamic component strategy for creating gadget instances during runtime - https://angular.io/guide/dynamic-component-loader
  • Faceted gadget search approach leveraging tags
  • Support multiple board creation
  • Drag and Drop support
  • Multiple Data Source/Endpoint management
  • Web Socket support
  • Completely customizable and configurable

Getting Started Developing a Gadget

The code includes a very simple Todo gadget that can be used as an example for getting started developing your own gadget. The following steps uses that Todo Gadget as a reference. You focus on defining the gadget and the rest of the framework will deal with making it available to the Add Gadget Modal, drag and drop, instance creation, tracking, persistence and cleanup, etc.

Define the Gadget Component, Service and View

Define the gadget's model

The model is used to dynamically create and render the gadget and its property page forms. This model is an entry into a model array used for all gadgets. You will simply add an entry to the model's array. See the Todo entry. Add an entry for the gadget in the library model array gadget-library-model.json

Add the gadget entry to the gadget factory class

Add an entry for your gadget in the factory gadget class gadget-factory.ts

Gadget Icon

Define an image/icon for your gadget todo.png

Gadget Module References

Todo Gadget

NgADF

This project was generated with Angular CLI version 7.x.

Setup

Clone this repository then run npm install

Development server

Run ng serve for a dev server. Navigate to http://localhost:4200/. The app will automatically reload if you change any of the source files.

Build

Run ng build to build the project. The build artifacts will be stored in the dist/ directory. Use the --aot --prod flag for ahead of time compilation and production mode.

The title of that issue suggests an issue with AOT but in my testing --prod seems to be the problem.

Running unit tests

Run ng test to execute the unit tests via Karma.

Running end-to-end tests

Run ng e2e to execute the end-to-end tests via Protractor. Before running the tests make sure you are serving the app via ng serve.

Source Code Documentation

This project uses the compodoc project : https://github.com/compodoc/compodoc

Run npm install -g @compodoc/compodoc to install compodoc globally Run compodoc -p tsconfig.json -n 'NGX Dynamic Dashboard Framework' to generate the documentation. It will be placed in the documentation folder Run compodoc -s to serve up the documentation site at http://localhost:8080

Spring Boot Backend Project

There is an accompanying java based backend project that serves up some of the endpoints used by the board.

https://github.com/catalogicsoftware/ngx-dynamic-dashboard-framework-microservice

It is a maven based project so you will need to do the following:

  • Install and configure Maven.
  • Copy the dist directory produced from this project's build into the static folder of the microservice project.
  • Build the microservice project using <directory path to maven bin folder>/mvn install from within the project's root directory.
  • Launch the microservice over the default port: http://localhost:8080 using java -jar <path to the microservice root folder>/target/ngxdd-x.y.z.jar

Further help

To get more help on the Angular CLI use ng help or go check out the Angular CLI README.