npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

eegeo.js

v0.1.1111

Published

A JavaScript API for beautiful 3D maps

Downloads

31

Readme

wrld.js

WRLD

The WRLD JavaScript API allows you to easily embed beautiful 3D maps into any web page for any modern, WebGL supporting browser. For an example of our 3D maps in action, see https://www.wrld3d.com/developers/javascript-maps/.

It is based on Leaflet.js, providing a familiar API for embedding 3D maps in a web page.

Examples

You can find feature-by-feature examples on our website.

API

A full API reference is also available on our website.

Getting Started

Before you begin, you will need to acquire an API key, which you can do by signing up for a free account at wrld3d.com.

You can easily embed a 3D map in any web page. The code below shows a simple example:

<!-- Create a map in an HTML element with wrld.js -->
<!DOCTYPE HTML>
<html>
  <head>
    <script src="https://cdn-webgl.wrld3d.com/wrldjs/latest/wrld.js"></script>
    <link href="https://cdnjs.cloudflare.com/ajax/libs/leaflet/0.7.7/leaflet.css" rel="stylesheet" />
  </head>
  <body>
    <div id="map" style="width: 400px; height: 400px;"></div>
    <script type="text/javascript">
      var map = L.eeGeo.map("map", "your_api_key_here");
    </script>
  </body>
</html>

Just replace your_api_key_here with an API key from wrld3d.com.

Support

If you have any questions, bug reports, or feature requests, feel free to submit to the issue tracker for wrld.js on GitHub.

Building the API

You may wish to build the API yourself. This is easy to do and only requires that you install node.js.

Requirements

  • Node.js (v4.4.1 tested)
  • npm (installed with Node.js)

Building

Follow the steps below to build the API:

  1. Clone this repo: git clone https://github.com/wrld3d/wrld.js.git
  2. In the root of the repo, run npm install to install the development dependencies.
  3. Still in the root of the repo, run the command npm run build.

This will create the files dist/wrld.js and dist/wrld.min.js which are the API and the minified form respectively.

You can also use the command npm run watch to build continuously, watching files for changes.

Contributing

If you wish to contribute to this repo, pull requests on GitHub are welcomed.

License

The eeGeo 3D Maps JavaScript API is released under the Simplified BSD License. See LICENSE.md for details.