NPMap.js

Extends Leaflet to include functionality and a look-and-feel built specifically for the National Park Service.

This library is under active development, so please help test and report issues.

NPMap Builder

You may also want to take a look at NPMap Builder. It is a graphical interface that walks through the process of building a map with NPMap.js, step-by-step.

Thanks

Heavily inspired (cough cough) by Mapbox.js, and, of course, built on the great Leaflet library. Standing on the shoulders of giants. Also, many thanks to the authors of all the great plugins used in/by the library (take a look at LICENSE.md for a list).

Versioning

NPMap.js is versioned using semantic versioning. This means that releases are numbered: major.minor.patch and follow these guidelines:

• Breaking backward compatibility bumps the major (and resets the minor and patch to zero)
• New additions that don't break backward compatibility bumps the minor (and resets the patch to zero)
• Bug fixes and miscellaneous changes bumps the patch

2.0.0 was the first official NPMap.js version. All versions < 2.0.0 are part of the original NPMap JavaScript library, which has now been deprecated.

Changelog

• v2.0.0
• v2.0.1
• v3.0.0
• v3.0.1
• v3.0.2
• v3.0.3
• v3.0.4
• v3.0.7
• v3.0.8
• v3.0.9
• v3.0.10
• v3.0.11
• v3.0.12

Hosted version

NPMap.js is hosted on the National Park Service's content delivery network. If you are a National Park Service employee, partner, or contractor, feel free to load the library directly from there. You can access hosted versions at http://www.nps.gov/lib/npmap.js/major.minor.patch/npmap-bootstrap.min.js. You should replace "major.minor.patch" with the number of the version you want to access (e.g. 2.0.0).

Keys

NPMap.js supports connecting to a number of services that require API keys. The National Park Service's keys are bundled into the library releases served from the agency's content delivery network (see the #hosted-version section above), so if you are loading the library from there, you should be good to go.

If, however, you are not a National Park Service employee, partner, or contractor, you will need to create a copy of keys.sample.json, rename it keys.json, add your keys, and run grunt build to bundle your keys into the build of NPMap.js that is created in the _dist folder.

Building

You must have node.js installed to run the build. After installing node.js:

git clone https://github.com/nationalparkservice/npmap.js
cd npmap.js
npm install

Install the Grunt command line tool (do this once as an admin user after installing node.js):

npm install -g grunt-cli

Copy secrets.sample.json to a file called secrets.json for development and testing:

cp secrets.sample.json secrets.json

Then use Grunt to build the library:

grunt build

Internally, the Grunt task uses browserify to combine dependencies. It is installed locally, along with other required packages, when you run npm install. The build task also uses uglify and cssmin to create minified versions of the library's CSS and JavaScript in dist/.

Testing

NPMap.js uses the Mocha JavaScript test framework, with the expect.js assertion library, and PhantomJS to run the tests. You can run the tests with either of the following commands:

grunt test

OR

npm test

We are working to expand test coverage for the library.

Documentation

Take a look at the API docs.

Examples

Simple and targeted examples reside in the examples directory. This is a great starting point if you're new to NPMap.js.

Support

You can get in touch with the NPMap team by contacting us via Twitter (@npmap) or email (npmap@nps.gov). We are happy to help with any questions. Feedback is welcome as well!