cartodb/Leaflet
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
1,121 Commits 13 Branches 25 Tags 44 MiB
JavaScript 93%
HTML 6.4%
Handlebars 0.6%
1b6e87eb8d
Go to file
Vladimir Agafonkin 1b6e87eb8d Merge pull request #540 from JasonSanford/gh-pages 
Documenting Rectangle, VERSION
2012-02-26 13:23:55 -08:00
build Merged #488 fix from stable, closed #488, allowed smart tabs 2012-02-15 11:03:39 +02:00
debug Merge branch 'master' into gh-pages 2012-02-15 11:27:55 +02:00
dist Merged #488 fix from stable, closed #488, allowed smart tabs 2012-02-15 11:03:39 +02:00
docs update features page 2012-02-25 12:46:14 +02:00
examples update quick start example 2012-02-25 13:03:29 +02:00
lib Try removing closure compiler again 2011-12-09 12:47:27 +02:00
spec merge last changes 2012-02-12 15:15:03 +02:00
src Merge branch 'master' into gh-pages 2012-02-15 11:27:55 +02:00
CHANGELOG.md Merged #488 fix from stable, closed #488, allowed smart tabs 2012-02-15 11:03:39 +02:00
CNAME new domain settings 2011-04-11 11:26:07 +03:00
download.html add CDN links on the download page 2012-02-25 12:18:00 +02:00
examples.html Add UserVoice widget to all pages 2012-02-21 17:14:40 +02:00
features.html update features page 2012-02-25 12:46:14 +02:00
index.html Change some links on the main page 2012-02-21 17:27:15 +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 Removed global switch for installing jshint and uglify-js 2012-02-14 00:58:37 +02:00
reference-tpl.html html template for docs 2012-02-26 13:45:44 +02:00
reference.html Documenting VERSION 2012-02-26 14:21:08 -07: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 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!