Skip to content

Latest commit

 

History

History
40 lines (24 loc) · 2.41 KB

README.md

File metadata and controls

40 lines (24 loc) · 2.41 KB

PunchClock

PunchClock is an in/out tracking app for iOS 7+ that uses iBeacon and Geofencing.

PunchClock Screenshot

PunchClock cannot operate on its own - It requires the PunchClockServer.

Building

In order to build PunchClock you'll need to do a few things:

  • $ cp PunchClock/constants.h.sample PunchClock/constants.h
  • $ cp PunchClock/PunchClock_Beta.xcconfig.sample PunchClock/PunchClock_Beta.xcconfig
  • $ cp PunchClock/PunchClock_Debug.xcconfig.sample PunchClock/PunchClock_Debug.xcconfig
  • $ pod install

The constants.h file will need to be customized for your environment. It's meant to allow you to run PunchClock against a local copy of the server during development and a production server after release. If you don't plan to use the Hockey or push notifications you can set those things to nil.

Code-signing is managed in the two xcconfig files. You'll need to paste in your provisioning profile UUIDs or you can manage code-signing in the workspace directly but you'll need to be careful about pushing these changes back in any subsequent pull-requests.

Usage

When PunchClock is first launched you'll be prompted for your name which will get stashed in the keychain and used as the key in the server-side database. This is a pretty naive way to go about things but it Works For Us™. The app will then ask the server for a list of all of the people and will get back some JSON showing everyone's status as well as who is watching who. Tapping the bell icon will mark you as tracking that person and you'll receive a push notification when their status changes. If you're being watched by anyone then there will be an eye icon next to their name. Tapping the chat icon in the top-left will allow you to send a message to anyone marked as "In".

The Information tab simply shows you the data that Core Location is returning. It can be useful for fine-tuning the placement of iBeacons and geo-fence settings. Tapping your name here allows you to change it. Note: the server doesn't currently manage name changes automatically - you'll end up with a new record.

Contributing

Feel free to fork and send us pull requests

Bug Reporting

PunchClock is an unsupported, unofficial Panic product. If you can't contribute directly, please file bugs here.