Github Mobile

Watch this repo to get alerts about this project.

Installing

First, clone this repository :

git clone [email protected]:hull/Github-Mobile.git

Install node.js (Only used for building the app, not needed for deployment)

grunt-cli as a global module. It's amazing so you should do it anyways.

[sudo] npm install grunt-cli -g
[sudo] npm install bower -g

then install grunt and it's modules in the project's folder.

cd Github-Mobile
npm install
bower install

Running the app

To run the app locally, run:

grunt server

• View the retinas for the Login Screen and the News Feed
• View the retinas for the Profiles V1 and the Modal Dialogs
• View the retinas for the Profiles V2, Activities, Starred Repos, and Repos list
• View the retinas for the Repo Landing Page, Repo Readme, and Repo Files list
• View the retina for the BackPane

What should I know?

• I've only worked on it a single day, obviously it's not released yet, just want to clarify right away
• Uses GitHub's V3 API
• Stores Access Token from OAuth with Local Storage, giving this webapp persistance
• Read + Write (at least what can be written while mobile, stars, followers, issues, etc)

What are you going to do?

• The entire GitHub Dashboard
• Users + relations, and ability to follow/unfollow
• Repos, ability to star, fork, submit issues
• Issues, Create, Discuss, Close
• Modify Account
• Notifications (no intent for native alerts at the moment)
• Search Search Search

When all is said and done, instead of uploading this to Apples App store, I will release it on... Bitbucket!

Just kidding, It will be open sourced on GitHub under the MIT license. The current GitHub clients in the App Store all look like crap and are not free. What the fuck?

Resource List

• Modified version of PIP from @gilbitron, thanks!
• Ratchet
• Unreleased, V2 of Sparky.js which is jQuery independent (will release soon)
• PHP API Library from KnpLabs
• Buzz
• Collegiate (not the actual font [anymore])
• IcoMoon icon generator. Navigate to IcoMoon, and in the lower left hand corner, click "Load" and use the json file from this gist to view the set. (Thanks again, @ColeTownsend)

And for the screens:

• 3/4 View iPhone 5

Changelog: What has been done?

1-16-2013

• Incorporated FastClick, feels almost native!
• Updated Shelf contents and animations
• Finally reworking the back button. I will provide an extensive writeup about the pitfalls and challenges I have faced while developing this mobile app with Ratchet.
• Fixed issues of translate3d giving me hell if elements position is set to fixed

1-15-2013

• Created initial backpane design
• Logout/session destroying
• Began initial stages for search setup
• Redesigning Issues to look less like the GitHub Issues app and more like this app itself

1-14-2013

• Took a hiatus this day. Coming back fresh ensures this project continues at an awesome rate.

1-13-2013

• Refactored User/Repo section
• Repo Page
• Repo Readme
• Repo File traversing and viewing, currently supported is text (js, php, css, etc) and images
• Watch/Unwatch functionality
• Star/Fork Button Counts
• "Shake to clear cache" experiment with modal window

Notes for 1-13-2013

I am concerned about a few major flaws in the application. Push.js from Ratchet is really annoying, but necessary, it is just a pain in the ass to extend, the flow of the app is weak. Will do an overhaul of that once everything is set in place.

1-12-2013

• Local Storage caching, blazing fast
• "Shake to Clear Cache" feature
• Began single repo screen
• Tightened some UI

1-11-2013

• Created Starred List
• Created User Activities List
• Created Repository List
• Tweaked Profile design
• Star/Unstar functionality
• Updates to Push.js, might be the only js used from Ratchet

1-10-2013

• Tightened up authentification on later calls to the GitHub API
• Created Profiles
• Profiles include the shiny new Contributions Graph that can be scrolled horizantally
• Follow/Unfollow Functionality
• Modal Implementation

1-9-2013

• Initial Issues list
• Starred Repos List
• Created Sexy GitHub-like Modals
• Started User Profiles
• Updated Event bindings

1-8-2013

• Consolidation, organization, gettin this mofo off the ground
• Login Screen synchronizes access token between local storage and session storage for ease of access
• Complete OAuth flow within a webapp (never navigates to Mobile Safari)
• First poll of actual News Feed (If anyone could answer my question at the very bottom, I'd appreciate it!)