Neon Geo Temporal Dashboard

The Neon Geo Temporal Dashboard (neon-gtd) is a sample analysis dashboard built upon the Neon Framework. It includes a number of geo-spatial and temporal data visualizations built as AngularJS directives that use the Neon framework to query and filter data served by MongoDB, Elasticsearch 1.7 or an Apache Spark server.

Neon is a software platform designed to help developers integrate disparate visualization widgets with your data stores. It includes a Data Access API that makes it easy to query an underlying database directly from JavaScript or RESTful endpoints. Additionally, the Neon Interaction API provides capabilities for inter-widget communication and shared data filters, allowing multiple visualizations to interact without being explicityly aware of one another.

This project was generated with angular-cli version 1.0.0.

Prerequisites

Building the neon-gtd application requires Node.js (Version 6.9.x or higher). Once node has been installed, you should install the Angular Command Line Interface with the following command:

	npm install -g angular-cli

The recommended package manager for the project is the Yarn Package Manager. npm can also be used.

Development server

Start a Neon server running on port 8080. As an alternate to building the server, you can use the Neon Quickstart Docker Image.

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

Code scaffolding

Run ng generate component component-name to generate a new component. You can also use ng generate directive/pipe/service/route/class.

Build

Run ng build to build the project. The build artifacts will be stored in the dist/ directory. Use the -prod flag for a production build.

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.

Deploying to Github Pages

Run ng github-pages:deploy to deploy to Github Pages.

Further help

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

View an example application

To see an example of this project, check out our demo server. Read more about how to use it and how it interacts with Neon here.

Build and run the example (TBD - Revise following migration to newer angular toolset)

Running the application requires a functioning Neon deployment. Links to the Neon deployment instructions and the command line instructions to build neon-gtd follow:

1. Build and Deploy a Neon server, drop the latest neon.war in a web application container such as Tomcat, or use the Neon Quickstart Docker Image.

2. Clone the neon-gtd repo

    git clone https://github.com/NextCenturyCorporation/neon-gtd.git
    cd neon-gtd/
   

3. Copy the sample NEON-GTD configuration file to the app config folder or supply your own. The configuration file specifies the default datasets and visualizations to display. It is described in detail here. The sample configuration file is setup for the sample earthquake data referenced in step 1.

    # Copy either the YAML or JSON config file.  If Neon-GTD cannot find one, 
    # it will look for the other.  
    cp app/config/sample.config.yaml app/config/config.yaml
    cp app/config/sample.config.json app/config/config.json
   

4. Use npm and grunt to download dependencies and build the application. This will create a neon-gtd war file in the neon-gtd/target directory.

    ng build
   

5. Deploy the neon-gtd-<version>.war file to your container from step 1. Note: On Tomcat, this may be as simple as copying the file to your /webapps folder. Optionally, you may want to rename the war file to be simply neon-gtd.war.

6. If running against a stock, localhost Tomcat instance, browse to the http://localhost:8080/neon-gtd/app/ to verify its installation. The Users Guide describes its basic use.

Documentation

Neon Git Repo - Visit the main Neon project and download its source code.

Neon Wiki - Visit the Neon wiki for more information on what Neon can do for you.

Build Instructions - Includes instructions for building the Neon WAR file from source code and lists Neon's external dependencies.

Deploying Neon - Includes instructions for deploying the Neon application to a web application container (e.g., Jetty or Tomcat).

Developer Quick Start Guide - A quick tour of how to develop apps that use Neon.

Apache 2 Open Source License

Neon and Neon-GTD are made available by Next Century under the Apache 2 Open Source License. You may freely download, use, and modify, in whole or in part, the source code or release packages. Any restrictions or attribution requirements are spelled out in the license file. Neon and Neon-GTD attribution information can be found in the LICENSE.TXT file and licenses folder in each of the Neon Git Repository and Neon-GTD Git Repository. For more information about the Apache license, please visit the The Apache Software Foundation’s License FAQ.

Additional Information

Email: [email protected]

Website: http://neonframework.org

Copyright 2016 Next Century Corporation