Skip to content

akinza/geoLocation

Repository files navigation

geoLocation

An requirejs app using Google Maps API v3 to show the coordinates of the location and show their position on map.

Getting Started

Make sure you have the latest packages installed

npm install
bower install

Note: If you don't have npm installed, make sure you have node installed. If you don't have bower, npm install -g bower.

The above steps will download all the required software to build and run this app, such as grunt, requirejs, and jquery.

Running the server

You can run your app using grunt preview. This will start a server on localhost:8000, meaning you can simply go to the url localhost:8000/index.html while it's running.

If you'd like to run the compiled version, run grunt preview-live.

Building the application

This application uses requirejs to load the various modules in the app folder. However, upon build, all of these files are concatenated and minified together to create a small, compressed javascript file.

Running grunt by itself will run through all of the steps of linting the javascript, building out dependencies and ultimately creating /dist/require.js.

Working with the scaffolded app

There's just enough to in place to get you going. Go ahead and make your changes to index.html. You'll start your javascript work in app/main.js by requiring your first modules. Past that, well, the world is your oyster.

Tests

Note: you need phantomJS to run the tests. The test directory uses qunit, which is run using phantomJS in the console, but can also be ran by launching the server grunt preview and going to localhost:8000/test/index.html.

Create tests in the test/tests.js file, where you can require your modules and test their functionality.

Deploying your application on a server

Assuming you're already ran npm install and bower install, the only pieces required to run the application in its built state is running grunt.

If you're using a webserver like apache or nginx, you'll want to create a redirect from /components/requirejs/require.js to /dist/require.js. (Note: this is exactly what grunt preview-live does)

License

The MIT License (MIT)

Copyright (c) 2014 Sanjay Rabidas

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

About

A Google Map API based app scaffolded with requirejs

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published