Giter VIP home page Giter VIP logo

open-knesset-mobile's Introduction

Open Knesset Mobile

Open Knesset Mobile (כנסת פתוחה) uses PhoneGap and Sencha Touch to construct a multi-platform mobile application for the Open Knesset website. This application is available free on the App Store and Android Market and will always be free. The purpose of this app is to increase transparency of Knesset activities, and to encourage people to be more involved with what is happening with the rulers of Israel's country.

This project is released as Open Source so that everyone can contribute to it. Please check our issue tracking system for stuff we'd be happy be done :)

Installation (for development)

  • Fork the repository to your github account

  • Clone the forked repository (first install git if you don't have it)

git clone [email protected]:<YOUR_GITHUB_USER>/Open-Knesset-Mobile.git
cd open-knesset-mobile
ant

You have to install ant first

Run the application (on a browser)

The Open Knesset Mobile application loads on a Google Chrome browser. After installation, open the index.html file under target\web\www directory

Understanding the code

The application is build with javascript over version 1.1 of the Sencha Touch framework (docs), and wrapped with version 1.1 of PhoneGap. The code structure follows the MVC paradigm, and specifically that which is described in this wonderfully written tutorial

Eclipse

I work with Eclipse and the Aptana plugin for development. I use the Egit plugin for git integration within eclipse:

XCode (iOS):

  • Xcode on a Mac machine
  • PhoneGap for iOS (download the tag 1.0.0 from github)
  • After building to project, Open 'Open-Knesset-Mobile/native/iOS/OKnesset/OKnesset' (with Xcode)

ADT (Android):

(PhoneGap for Android is included in this git repository)

  • run the following git commands to clone the PhoneGap submodule:

git submodule init
git submodule update
  • Install The ADT plugin for Eclipse
  • import the eclipse project in 'Open-Knesset-Mobile/native/Android/OKnesset/'

Troubleshooting

Windows:


  1. if you get an Error like this when running ant:

    'ant' is not recognized as an internal or external command, operable program or batch file.

    You need to download and install ANT on your machine.

Guidelines

  • When modifying javascript files, please use the 'javascriptFormatting.xml' formatting settings so that file merges and code reviews would be easier.
  • Try to follow These Guidelines from PhoneGap's Contributer Workflow on how to make pull requests for the project

How to contribute code?

Making a branch for your changes

When adding features or bug fixes, please create a separate branch for each changeset you want us to pull in. Use the issue number in the branch name, or a description of the feature. To create the branch, do something like this:

git branch   (lists your current branches)
git branch my_new_code   (makes a new branch called my_new_code)
git checkout my_new_code

** Push your code and make a pull request**

When you have finished making your changes, you'll need to push up your changes to your fork so we can grab them. With them all committed, push them:

git push origin my_new_code

This pushes everything in that branch up. Then you can go back over to the main github page and issue a pull request from there. Tell us what you want us to merge and what it does/fixes, and one of us will pick it up.

That lets us know that there's something new from you that needs to be pulled in. We'll review it and get back to you about it if we have any questions. Otherwise, we'll integrate it and let you know when it's in!

open-knesset-mobile's People

Contributors

gardenofwine avatar noamkfir avatar anatdagan avatar

Stargazers

 avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.