Skip to content

Latest commit

 

History

History
44 lines (30 loc) · 1.39 KB

README.md

File metadata and controls

44 lines (30 loc) · 1.39 KB

MateMonkey.com Frontend

Hi! This is the Javascript frontend for MateMonkey It is written using AngularJS and uses Leaflet for displaying the map.

Development

This project uses Brunch to build the final product.

Installation / First Start

  • Install nodejs
  • Install brunch (e.g. using npm)
  • Install bower (e.g. using npm)
  • Install all development dependencies by running npm install
  • Install all source dependencies by running bower install
  • Start your local server by running brunch watch --server

API

Click here for the full API documentation

The frontend uses playground.matemonkey.com when built for development. Have a look at app/js/config/api.yaml and the urlfor service that is defined in app/js/application.js to learn how this works ;).

Please make sure that you always build the project for development if you are creating a new feature/fixing a bug - otherwise you will change production data! Thanks!

Contributing

Please fork the repository and create a feature branch for a pull request. (DO NOT COMMIT IN MASTER! :rage1:)

License

Copyright 2015 Maximilian Güntner [email protected]

This software is licensed under the GPL, version 3. See gpl-3.0.txt for the full text.