Skip to content
Rotem Nehama edited this page Apr 25, 2015 · 6 revisions

Developer Guide - BudgetBuddy

How to get the code?

The source code is available in BudgetBuddy Source Code directory in this repository:
Source Code

Project License

Copyright (c) 2015, Rotem Nehama, Itay Michael, Nadav Luzzato, Liran Ben Gida, JCE
All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

  1. Redistribution of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

  2. Redistribution in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANT ABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Information about directory structure and files in the project

In the Source Code Directory you will find the directories and files:

  • web - Directory contain all project web pages.
  • Models - Directory contain defines to DB models.
  • API - Directory for Google API.

How to compile the project?

Using Google-App Engine - more explanation can be found at Google App Engine with Python Guide

How to debug the project?

  • Chrome's 'Inspect Element' to debug within a browser (javascript, html and css debugging)

* Pycharm Debugger (Python)

How to prepare a new version?

The new version will appear at our page under 'master' branch.
The version number depends on the milestone we'll have during the new version development

How to get the list of bugs and get task to work on bug

Each bug will be found in Product Backlog under the label Bug. To work on bug you need to execute the next directions:

  • Update in project task board you are working on bug with specify the bug itself and with "In progress" label.
  • Update in Product Backlog that you are assigned to the bug.
  • When you finish the work on the bug Update the bug label to "done" in project task board.

Project Documentetion

The source code will be document with commends for every source file and every method.

Clone this wiki locally