cartodb/Leaflet
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
842 Commits 13 Branches 25 Tags 44 MiB
JavaScript 93%
HTML 6.4%
Handlebars 0.6%
587eafca2a
Go to file
mourner 587eafca2a improve build helper instructions
2011-12-12 22:37:30 +02:00
build improve build helper instructions 2011-12-12 22:37:30 +02:00
debug Fixed min zoom recalculation on resize when max bounds enabled 2011-12-07 15:58:06 +02:00
dist update build 2011-12-12 22:10:29 +02:00
lib Try removing closure compiler again 2011-12-09 12:47:27 +02:00
spec Merge pull request #189 from anru/domutil 2011-07-20 04:27:12 -07:00
src integrate jshint into Jakefile, minor cleanup 2011-12-12 19:54:03 +02:00
CHANGELOG.md Fixed GeoJSON pointToLayer not working inside a GeometryCollection, closed#391 2011-12-09 18:19:58 +02:00
Jakefile.js fix line endings and update build 3 2011-12-12 22:21:20 +02:00
LICENSE fix license whitespace 2011-06-17 01:36:31 +03:00
README.md Readme update 2011-12-12 21:51:27 +02:00

README.md

Leaflet

Leaflet is a modern, lightweight BSD-licensed JavaScript library for making tile-based interactive maps for both desktop and mobile web browsers, developed by CloudMade to form the core of its next generation JavaScript API.

It is built from the ground up to work efficiently and smoothly on both platforms, utilizing cutting-edge technologies included in HTML5. Its top priorities are usability, performance and 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:

  1. Download and install Node
  2. Run the following commands in the command line:
npm install -g jake
npm install -g jshint
npm install -g 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!