Quickstart for developers

WebGL Earth is prepared to be used on third-party websites and in projects developed by other people. The developers have two options how to use the source code of the WebGL Earth project for custom web applications, the API and the codebase:

JavaScript API: 3d globe for your own website

This is the traditional model of using an external JavaScript library, known from Google Maps API or OpenLayers, where a developer inserts a prepared file (such as "http://www.webglearth.com/api.js") into the HTML header and then calls the publicly available JavaScript methods to embed and control an instance of the WebGL Earth in his own website with custom map data or markers.

With a few lines of code anybody can use the 3D planet from WebGL Earth project inside of his own web.

>>> Read more at: JavaScript API.

Standalone JavaScript applications compiled with WebGL Earth codebase

WebGL Earth is (thanks to the integration with Google Closure compiler) fully usable in a form of library, which you can compile together with your own complex JavaScript application. The shareable codebase of the WebGL Earth is available in the "we" directory.

The sources contain also an example of a standalone application - in the subtree "weapp". You know the application already from the live demo website at http://www.webglearth.com/. Feel free to customize it, modify or use the code for inspiration for your own online projects.

The structure of the code and algorithms and principles behind WebGL Earth are described in the manual: http://data.webglearth.com/doc/

These are the steps you should follow to setup WebGL Earth development environment:
  1. You need Python Interpreter and Java Virtual Machine in order to successfully compile WebGL Earth source code.
  2. Download the source code from our GitHub repository: https://github.com/webglearth/webglearth
  3. Under Linux & Mac: just run "make"
  4. Under Windows: download latest Closure Library and unpack the Closure Compiler into the project directory. Now you are ready to run build_app.bat to build WebGL Earth Application or build_api.bat to build WebGL Earth API.
If you have any problems following these steps, feel free to ask at WebGL Earth Developer Group.

>>> Read more at: Contribute.
Comments