https://github.com/jprivillaso/geolocationapp
https://github.com/jprivillaso/geolocationapp
Last synced: 23 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/jprivillaso/geolocationapp
- Owner: jprivillaso
- Created: 2015-10-20T02:02:33.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2015-10-20T02:32:15.000Z (over 9 years ago)
- Last Synced: 2023-03-23T12:55:40.695Z (about 2 years ago)
- Language: JavaScript
- Size: 211 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# GeoLocation App #
This project is a Geolocation App that retrieves your position or a custom url location in a map
## Getting Started
Download all the project at the left side bar or clone the repository
## Dependencies
NodeJs and NPM installed on your machine
Libraries used:
1. AngularJs -> Powerful javascript framework
2. AngularJs-Mocks -> To create mocks in tests in AngularJs
3. Angular-Route -> To create routes easily in the application
4. Bootrstap -> Powerful library to create responsive sites
5. Jquery -> Chose JQuery to navigate through DOM
6. lodash -> Has a lot of useful methods for Strings, Collections and Objects that can be used in any application
7. Jasmine -> UI testing because it has a good integratino with Angularjs
8. Karma -> To run the tests with node.js from the console
9. bower -> To easily manage ui dependencies
10. Express -> Easy NodeJs framework for creating web application
11. Google-Maps -> Google Maps library to display maps and markers inside it
12. Google-Maps-Mock -> Google Maps mock library to allow to test the application
13. URI -> Library to manipulate URI's
Download node [here](https://nodejs.org/en/).
## Clone Geolocation App
git clone https://[email protected]/ac-recruitment/ui-challenge.git
## Run the Application
The application must have all the dependencies installed in order to run without any problems.
Type in your shell the following
npm start
When you type "npm start" the application is going to follow the next steps
1. npm install -> Install all the dependencies of the project and place them in a folder called npm_modules
2. bower install -> Install all the ui dependencies and place them in a folder called bower_components
3. node ./bin/www -> Start a local server throug a script called www
The first time you run the script, it will take some time because it will download all the dependencies
After the following message appears in your console, you will be able to run your application
node ./bin/www
By default it's configured at port 3000, so access your browser at http://localhost:3000
## Directory Layout
```
root/
bin/
www -> Script to start a local server
node_modules/ --> node dependencies
public/
bower_components/ -> front-end dependencies
angular/ -> library files
angular-mocks/ -> library files
angular-route/ -> library files
bootstrap/ -> library files
jquery/ -> library files
lodash/ -> library files
css/
geolocation.css -> app styles
routes/
index -> Index route to retrieve index.html
images/
js/
controllers/
GeolocationController.js -> GeolocationApp Controller and funcionality
directives/
services/
Location.js -> Service that retrieves information of the sites
tests/
GeolocationTest.js
vendor/
google-maps.js -> Google Maps api to display maps in your app
google-maps-mock.js -> Google Maps Mock for testing
URI.min.js -> URI manipulation
geolocation.js -> angular app definition
templates/
geolocation.html -> Geolocation html template
favicon.ico
app.js -> node-express application script
.bowerrc -> bower configuration file
bower.js -> bower dependencies configuration file
karma.conf.js -> config file for running unit tests with Karma
package.json -> node dependencies configuration
```
## Tests
Tests can be executed typing the following at your command line
npm test
A browser will be open and an overview of the tests will be displayed at the console