Skip to content

Latest commit

 

History

History
63 lines (42 loc) · 2.99 KB

README.markdown

File metadata and controls

63 lines (42 loc) · 2.99 KB
Raw

angular-google-maps

AngularJS directives for Google Maps

Dependencies  Dependencies  Build Status ##What is new (1.2.X):

With the minor release of 1.2.0 (which is why it is a minor) there are a few breaking changes:

  • all directives are now restricted to EA see here and search for 'restrict'
  • marker directive now requires the attribute idkey to be defined and it is not optional like markers or windows. This is to prevent unnecessary redraws.

If I have forgotten anything then it can be added here or to the website branch which is responsible for... the website. Feel free to contribute and make pull requests to either.

##What is to come (2.0.X): 2.0.0 will introduce the (major change) nggmap namespace which will be appended to all directives, services, and factories.

The main goal for this is to decrease conflicts with external libraries. The other major reason for this is to not conflict with svg definitions like polygon or marker.

Getting started

This is a directive for AngularJS ~1.0.7+, ~1.2.2+.

If you plan to hack on the directives or want to run the example, first thing to do is to install NPM dependencies:

npm install
bower install ( for specs and dev dependencies)

Building

To build the library after you made changes, simply run grunt:

grunt

If you get errors from jshint, just add the --force argument.

Running the example

To run the example page, just run

grunt example

and open your browser on http://localhost:3000/example.html.

Documentation

The various directives are documented at official site.

Contributing

Pull requests more than welcome! If you're adding new features, it would be appreciated if you would provide some docs about the feature. This can be done either by adding a card to our Trello board, forking the website branch and issuing a PR with the updated documentation page, or by opening an issue for us to add the documentation to the site.

Branching Model w Git Flow We are trying to follow the git flow branching model where all bugs that are considered urgent / patches will be pull requested against master. If the PR (pull request) is an improvement and a non urgent fix it will go towards develop which is the working(SNAPSHOT) next version of what master will be.

When patches and bugs are rolled into master they will be immediatley rolled into develop as well. Where the flow is PR(bug fix) -> merge master -> merge develop .