patrickmcelwee / developing-analytics-dashboard

This is a host application for https://github.com/patrickmcelwee/ml-analytics-dashboard-ng - useful for developing and testing

Developing the ML Analytics Dashboard

This application is a host application for developing the ml-analytics-dashboard-ng library. It works with MarkLogic 9. It was generated by the MarkLogic-Node Slush generator, with the following components:

• AngularJS
• Gulp
• node.js: very thin layer, hosting the Angular code and proxying MarkLogic REST API requests
• Roxy Deployer: bootstrap MarkLogic databases, application servers, etc; scaffolding for MarkLogic REST API service extensions

Install Required Dependencies

• node.js
• npm: Built-in package manager for node (comes with node, but check to be sure you have latest version: npm install -g npm)
• gulp: Javascript task automation (npm install -g gulp)
• Bower: A package manager for front-end libraries (npm install -g bower)
• Git - Roxy depends on this version control system
• Ruby - Roxy depends on Ruby in order to run server configuration scripts

Running the application

./ml local bootstrap
./ml local deploy modules

On Windows, that would be:

ml.bat local bootstrap
ml.bat local deploy modules

Install additional dependencies using the npm and bower package manager:

npm install
bower install

Load the sample data, used by automated end-to-end tests, as described in the ml-analytics-dashboard-ng README.

./ml local mlcp -options_file import-sample-data.options

Or on Windows:

ml.bat local mlcp -options_file import-sample-data.options

You can optionally install the Northwind dataset:

./ml local deploy_data

On Windows:

ml.bat local deploy_data

To run a local server on port 3000. Edit ./local.json to set your desired ports

gulp serve-local # this will watch the .less file for changes, compile them to .css, and run the node server

How to actively develop ml-analytics-dashboard-ng using this application

Once it is running, you can link a local version of ml-analytics-dashboard-ng. The dist/ folder of ml-analytics-dashboard-ng will be actively used. (This means that it will pick up any changes that you have compiled to the dist/ folder using the gulp command in your local ml-analytics-dashboard-ng directory.)

First, navigate to the ml-analytics-dashboard-ng directory and run:

bower link

Then, return to this developing-analytics-dashboard directory, and run:

bower link ml-analytics-dashboard-ng

Now, if you examine bower_components/ in this directory, you should see a symlink to your local version of ml-analytics-dashboard-ng.

Installation and deployment on server

See INSTALL.md