@asymmetrik/angular2-leaflet

@asymmetrik/angular2-leaflet

Leaflet packages for Angular 2 Provides flexible and extensible components for integrating Leaflet v0.7.x and v1.0.x into Angular 2 projects.

Table of Contents

• Install
• Usage
• API
• Contribute
• License

Install

This package is intended to be a starting point for a new project in a new repository. As such, installation involves forking the repository, or cloning it and optionally removing the .git directory to get rid of the repository history.

Forking the repository will allow you to maintain a common history with this project. This will allow you to periodically perform git merges with this repository to pull in patches and improvements. If you want total freedom and are willing to manually merge changes in the future, feel free to delete the git history of your clone.

To get started, ensure that Node and NPM are installed.

• Node and NPM (https://nodejs.org)
• Gulp (https://gulpjs.org)

Use npm to install gulp globally:

npm install -g gulp

Next, clone the repository and then install the npm packages in the project directory:

npm install

At this point, you should be ready to build the project.

Usage

This project uses Gulp as a build framework. There are two primary tasks: build and dev, which build distribution artifacts and run the development server respecitvely.

Building Artifacts for Distribution

To build the bundles run:

gulp build

This task will run TSLint over the source Typescript to ensure code quality and consistency. Then, it runs the Typescript compiler to generate ES5 Javascript. Finally, it uses Rollup to bundle the generated Javascript into and then uses Rollup to bundle the Javascript code into a distributable CommonJS format.

Run the Demo for Development

To run the demo using Webpack dev server, run

gulp dev

This task will run Webpack dev server, watch all of the files in the project for changes, and make a server available where you can run the demo application. Gulp watch will monitor for changes to Typescript source and re-run the TSLint.

API

Contribute

PRs accepted. If you are part of Asymmetrik, please make contributions on feature branches off of the develop branch. If you are outside of Asymmetrik, please fork our repo to make contributions.

License

See LICENSE in repository for details.