A simple tool for easily creating Google Street View frame based animations.
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
demo
dist
src
tools
.gitignore
Gruntfile.js
LICENSE
README.md
bower.json
package.json

README.md

StreetViewAnimator

Project Status

A simple tool for easily creating Google Street View frame based animations. Demo

## How to use

Basic Usage

The easiest way to install streetveiwanimator.js is via Bower.

bower install streetviewanimator

Include the JS in your page, remembering to include the dependencies: Google Maps and jQuery. Note that you will require an API key and also specify that we load the geometry library.

<script type="text/javascript" src="https://maps.googleapis.com/maps/api/js?key=YOUR_API_KEY&libraries=geometry"></script>
<script type="text/javascript" src="assets/bower_components/jquery/dist/jquery.min.js"></script>
<script type="text/javascript" src="assets/bower_components/streetviewanimator/dist/streetviewanimator.min.js"></script>

Instantiate streetviewanimator like so:

[@todo]

Options

The following options are available to you:

[@todo]

How to Contribute

I welcome contirbutions to streetviewanimator. Fork the repo and submit a pull request. Please ensure that streetviewanimator.js compiles and that any relevant documentation is updated before sending the pull request.

Compiling the JS

I use Grunt to compile everything. Firstly, install grunt-cli tool globally. It's recommended to run the grunt client on a per-project basis.

npm install -g grunt-cli

Install the dev dependancies in your project:

npm install --dev

The following Grunt task is available for compiling the JS:

grunt build

If you want to watch for changes in src/*.js files then simply call Grunt with no arguments:

grunt