A Commute App for Sri Lanka
People travel to the same destination on a regular basis for various reasons using public and private transport. In Kute, the users (also known as travellers) themselves are allowed to share their current location, so that the other travellers can see the current location of the vehicle. A common type of vehicle used for public transport in Sri Lanka is the passenger train. Kute is currently implemented for trains. A registered user can update the current location of a train when travelling by sharing the current location. Another user can view location of a selected train and the expected time a particular train arrives at the nearest station using the location data updated by another user.
-
Go to your terminal and execute this command
git clone https://github.com/scorelab/kute.gitor download the zip file
-
Launch android studio (version 1.4 above)
-
Click on File, then New and then Import Project Or from the welcome screen of android studio click on Import project (If you wish to contribute, you can directly link to GitHub)
-
Browse to the directory where you cloned (extracted the zip)
-
Update kute-android-app/app/src/main/res/values/strings.xml with a facebook app id and google maps api key
... <string name="facebook_app_id">YOUR_FB_APP_ID</string> <string name="googlemapApi">YOUR_GOOGLE_MAPS_API_KEY</string> ... -
Run and build the Gradle
-
If Gradle finishes to build without error run the project by clicking on the play button on the tool bar
-
Wait for a few seconds and the app should start on your device (android phone or emulator)
-
Make sure you are connected to internet
Google Code-in users should checkout the c_in_refine branch for all tasks.
git checkout c_in_refine
You'll have all the necessary information to procede in there.
Please help us follow the best practice to make it easy for the reviewer as well as the contributor. We want to focus on the code quality more than on managing pull request ethics. Follow Github Flow.
-
People before code: If any of the following rules are violated, the pull-requests must not be rejected. This is to create an easy and joyful onboarding process for new programmers and first-time contributors.
-
Single commit per pull request and name the commit as something meaningful
-
Reference the issue numbers in the commit message if it resolves an open issue. Follow the pattern
Fixes #<issue number> <commit message> -
Provide relevant screenshot for easier review.
-
In case there are multiple commits on the PR, the commit author should squash them.
-
Avoid duplicate PRs, if need be comment on the older PR with the PR number of the follow-up (new PR) and close the obsolete PR yourself.
Happy Contributing!
This project is licensed under the terms of the Apache License 2.0.