Giter Club home page Giter Club logo

emp3-web's Introduction

Extensible Map Platform 3 (EMP3) - Web SDK

Branch Build Status
master Build Status
development Build Status

This project contains the EMP3 Map API, and Core SDK components as well as a map application with UI components leveraging the EMP SDK.

This project is built using Node.js and Grunt. If you do not have node on your system, please install node (5.0 or later) following instructions at Node.js

Once Node.js is installed navigate to the root of the EMP3 project, open a command prompt and run:

npm install -g grunt-cli
npm install

This will install the Node.js dependencies for this project.

For default build (developer quick build - unit tests, code linting, and minification) run:

grunt

This will run the Grunt tasks which include unit tests, code linting, and minification for the distribution files for the emp3-web-sdk.

For release build (includes developer quick build outputs plus JSDocs, zipped outputs, and WAR file for map application) run:

grunt release

All outputs will appear in the "dist" folder The dist folder is removed automatically for each build

Common Grunt Tasks

Task description
default default Grunt build; generates uglified output and docs but no wars or zips
release cleans and builds all documentation, minified files, zips, and wars
jsdoc generates JSDocs to dist/doc
clean removes dist folder and contents
test runs unit tests
serve runs the development server (see below for additional details)

Unit Tests

Using Grunt

To Test the debug versions of the library

grunt test

To Test the minified version of the library

grunt
grunt testRelease

From the browser

Invoke the debug or minified test command first (see above)

Then to view the unit tests in a browser launch the file.

test/index.html

from the browser you want to test in.

Development Validation Tool

To run the validation tool locally run

npm install
grunt serve

Then open a browser to localhost:3000/src/validation/

  • If changes are made to the validation tool it will reload automatically.
  • If changes are made to the emp3 library reload the page

Creating Additional Validation Tests

New tests should be created in src/validation/js/components

Register the new test with the manifest src/validation/js/TestManifest.js

emp3-web's People

Contributors

alberto-acevedo avatar eric-briscoe avatar ish-rivera avatar erikamarie avatar ronnielsen avatar jaybarra avatar jacochran avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.