Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 62 lines (39 sloc) 2.347 kb
b26ae04 @maccman rename
authored
1 # Heads Up
96ad12a @maccman few fixes
authored
2
3850fda @maccman update README
authored
3 A simple Heads Up display showing your calendar items for today, your unread emails and custom notes.
ad04bff @maccman some sizzle
authored
4
4d30f13 @maccman update with new download link
authored
5 [Download the OSX app](http://cl.ly/DlUM) or try the [live demo](https://maccman-headsup.herokuapp.com).
3d6a185 @maccman readme tweaks
authored
6
e9864c2 @maccman some tweaks
authored
7 [![Heads Up](http://f.cl.ly/items/0g0g0a0L1P1l2W2W0m3r/Screen%20Shot%202012-01-29%20at%2013.06.59.png)](https://maccman-headsup.herokuapp.com)
15f5b30 @maccman add readme
authored
8
9 Heads Up contains good examples of how to use:
3850fda @maccman update README
authored
10
11 * [Spine](http://spinejs.com)
12 * [GFX](http://github.com/maccman/gfx)
13 * [Omniauth](https://github.com/intridea/omniauth)
14 * [MacGap](http://github.com/maccman/macgap)
15 * [Nestful](http://github.com/maccman/nestful)
16 * [Rack::Offline](http://github.com/maccman/rack-offline)
17
3d6a185 @maccman readme tweaks
authored
18 ## Source
19
20 If you're browsing the source, the interesting files are:
21
22 * [`dashboard.js.coffee`](https://github.com/maccman/headsup/blob/master/app/assets/javascripts/app/controllers/dashboards.js.coffee)
23 * [`authorize_controller.rb`](https://github.com/maccman/headsup/blob/master/app/controllers/authorize_controller.rb)
24 * [`user.rb`](https://github.com/maccman/headsup/blob/master/app/models/user.rb)
25 * [`google.rb`](https://github.com/maccman/headsup/blob/master/lib/google.rb)
3850fda @maccman update README
authored
26
3d6a185 @maccman readme tweaks
authored
27 ## Google keys
15f5b30 @maccman add readme
authored
28
29 If you're running the app locally, or using Heroku, you'll first need to obtain a set of [API keys from Google](https://code.google.com/apis/console/), as well as specify the correct redirect URLS:
30
31 ![Redirect URLS](http://f.cl.ly/items/1R323Y3h2F322h211g1j/Screen%20Shot%202012-01-29%20at%2008.50.48.png)
3850fda @maccman update README
authored
32
3d6a185 @maccman readme tweaks
authored
33 ## Running locally
3850fda @maccman update README
authored
34
35 git clone git://github.com/maccman/headsup.git
36 cd headsup
ad04bff @maccman some sizzle
authored
37
e25216c @maccman update readme
authored
38 bundle
39 rake db:setup
15f5b30 @maccman add readme
authored
40 export GOOGLE_KEY=mykey GOOGLE_SECRET=mysecret
41
e25216c @maccman update readme
authored
42 rails s thin
ad04bff @maccman some sizzle
authored
43
3d6a185 @maccman readme tweaks
authored
44 ## Deploying to Heroku
e25216c @maccman update readme
authored
45
46 git clone git://github.com/maccman/headsup.git
47 cd headsup
48
49 heroku create myapp --stack cedar
50 heroku addons:add piggyback_ssl
15f5b30 @maccman add readme
authored
51 heroku config:add GOOGLE_KEY=mykey GOOGLE_SECRET=mysecret
52
e25216c @maccman update readme
authored
53 git push heroku master
54 heroku run rake db:setup
ad04bff @maccman some sizzle
authored
55
3d6a185 @maccman readme tweaks
authored
56 ## Building the app with MacGap
15f5b30 @maccman add readme
authored
57
58 [MacGap](http://github.com/maccman/macgap) is a utility for wrapping up web apps with a WebKit wrapper, and exposing a basic OS integration API.
59
776f2d1 @maccman no subject
authored
60 If you want to build the MacGap application, you'll first have to edit the redirect endpoint in `./macgap/index.html` to point to your remote application, and then run:
ad04bff @maccman some sizzle
authored
61
62 rake macgap:build
Something went wrong with that request. Please try again.