Leaflet

Go to file

emartinez 765e07d69c Created keyboard handler for map panning/zooming.		2012-05-03 11:00:30 -06:00
build	Created keyboard handler for map panning/zooming.	2012-05-03 11:00:30 -06:00
debug	Clean up commented lines	2012-03-19 04:29:17 +00:00
dist	fix superclass regression	2012-03-09 11:28:14 +02:00
spec	fix superclass regression	2012-03-09 11:28:14 +02:00
src	Created keyboard handler for map panning/zooming.	2012-05-03 11:00:30 -06:00
.gitignore	more cleanup	2012-02-25 18:57:28 +02:00
CHANGELOG.md	fix typo	2012-02-25 17:26:05 +02:00
Jakefile.js	Update changelog and build	2012-02-13 16:25:57 +02:00
LICENSE	fix license whitespace	2011-06-17 01:36:31 +03:00
README.md	Update README.md	2012-04-12 01:24:40 -03:00

README.md

Leaflet is a modern, lightweight open-source JavaScript library for mobile-friendly interactive maps, developed by CloudMade to form the core of its next generation JavaScript API. Weighting just about 21kb of gzipped JS code, it still has all the features you will ever need for your web mapping needs while providing a fast, smooth, pleasant user experience.

It is built from the ground up to work efficiently and smoothly on both desktop and mobile platforms like iOS and Android, utilizing cutting-edge technologies included in HTML5 and CSS3, focusing on usability, performance, small size, A-grade browser support, flexibility and easy to use API. The OOP-based code of the library is designed to be modular, extensible and very easy to understand.

Check out the website for more information: leaflet.cloudmade.com

Contributing to Leaflet

Let's make the best open-source library for maps that can possibly exist!

Contributing is simple: make the changes in your fork, make sure that Leaflet builds successfully (see below) and then create a pull request to Vladimir Agafonkin (Leaflet maintainer). Updates to Leaflet documentation and examples (located in the gh-pages branch) are really appreciated too.

Here's a list of the awesome people that joined us already. Looking forward to your contributions!

Building Leaflet

Leaflet build system is powered by the Node.js platform and Jake, JSHint and UglifyJS libraries, which install easily and work well across all major platforms. Here are the steps to install it:

Download and install Node
Run the following commands in the command line:

npm install -g jake
npm install jshint
npm install uglify-js

Now that you have everything installed, run jake inside the Leaflet directory. This will check Leaflet source files for JavaScript errors and inconsistencies, and then combine and compress it to the dist folder.

To make a custom build of the library with only the things you need, use the build helper (build/build.html) to choose the components (it figures out dependencies for you) and then run the command generated with it.

If you add any new files to the Leaflet source, make sure to also add them to build/deps.js so that the build system knows about them. Happy coding!