Skip to content
Newer
Older
100644 169 lines (116 sloc) 5.55 KB
2db300b @alexch adjust readme for couchbase dev install
authored Nov 8, 2011
1 # Summary
2
3 Google kidnapped our sharebros! And we want them back.
4
5 # Developers
6
7 ## Install a local CouchDB server
8
9 <http://www.couchbase.com/downloads/couchbase-single-server/community> (formerly CouchDBX) is the easiest way.
10
11 <http://couchdb.apache.org/downloads.html> is another way but is more technically arduous.
12
13 See also <http://www.google.com/search?q=couchdb+install>
14
1c434c8 @alexch save google data in couchdb
authored Nov 8, 2011
15 Once you install CouchDB, leave it as an "Admin Party" so we don't need a local password. If you figure out a way to add a password without making it hard for developers, please let me know.
16
2db300b @alexch adjust readme for couchbase dev install
authored Nov 8, 2011
17 ## Clone the repo
18
19 git clone git://github.com/alexch/sharebro.git
20 cd sharebro
21
22 ## Install the gems
23
24 gem install bundler
25 bundle install
26
27 Note that we require Ruby 1.9.2 or greater.
28
f7bb94a @alexch documenting new config.yaml system
authored Nov 24, 2011
29 ## Install your own config.yaml file
2db300b @alexch adjust readme for couchbase dev install
authored Nov 8, 2011
30
31 You need to get oauth creds from Google. [TODO: links] (sharebro.org has its own creds that I'm not putting in the git repo, though you can learn them if I make you an admin of the heroku app.)
32
f7bb94a @alexch documenting new config.yaml system
authored Nov 25, 2011
33 Put them in a file under a directory called 'local' called `config.yaml` that looks like this:
2db300b @alexch adjust readme for couchbase dev install
authored Nov 8, 2011
34
35 ---
36 oauth_consumer_key: example.com
37 oauth_consumer_secret: ABC123xyzPDQ
f7bb94a @alexch documenting new config.yaml system
authored Nov 25, 2011
38
39 "local" is `.gitignore`d so if you deploy to Heroku you need to add those as environment variables, e.g.
40
41 heroku config:add OAUTH_CONSUMER_KEY="example.com" OAUTH_CONSUMER_SECRET="ABC123xyzPDQ"
42
43 If you end up deploying to Heroku you can put heroku email/password creds in there too, which will be important if we want to scale heroku workers from inside heroku web processes. More on that later once it works :-)
2db300b @alexch adjust readme for couchbase dev install
authored Nov 8, 2011
44
45 ## Run the tests
46
12ec7c9 @alexch notes
authored Nov 12, 2011
47 Um, we don't really have any good ones yet. Sorry.
2db300b @alexch adjust readme for couchbase dev install
authored Nov 8, 2011
48
12ec7c9 @alexch notes
authored Nov 12, 2011
49 rake spec
50
51 (In good Ruby style, plain `rake` also runs the tests.)
2db300b @alexch adjust readme for couchbase dev install
authored Nov 8, 2011
52
53 ## Launch the app!
54
55 rake run
56
57 this will fire up the server and launch <http://localhost:9292>, and use `rerun` so it'll relaunch if you change a file. Since I'm on Mac it also runs `open http://localhost:9292` but that'll fail on other systems so don't worry about it.
58
59a16b2 @alexch misc notes
authored Nov 19, 2011
59 # TODO (site design):
87815a4 @alexch initial readme
authored Nov 1, 2011
60
5bd46ea @alexch refactoring, notes, style tweaks, a few notes
authored Nov 14, 2011
61 * better colors
f2c5de2 @alexch site needs a tag line and stuff
authored Nov 5, 2011
62 * tagline
59a16b2 @alexch misc notes
authored Nov 20, 2011
63 * logo
64 * simple \S/ icon
65 * turn logo into favicon.ico
66
67 # TODO (features and design):
87815a4 @alexch initial readme
authored Nov 1, 2011
68
5d07c81 @alexch skip items missing an href
authored Nov 21, 2011
69 * "Send To Sharebro" or "Send to Shares"
70 * BUG: reauth should redirect back to "Send To" page with original parameters
f033c21 @alexch notes
authored Nov 21, 2011
71 * works, now make it real
72 * can it pop up or go back to reader?
73 * proper "i did it!" message, maybe with a countdown to closing the tab
5d07c81 @alexch skip items missing an href
authored Nov 21, 2011
74
75 * "Subscribe in Reader" should add lipsumar feeds that exist
76
77 * "clean up" step
78 * remove nonexistent lipsumar feeds from Shares
79 * add "Send To Sharebro" link
f033c21 @alexch notes
authored Nov 21, 2011
80 * put "Shares" at the top
5d07c81 @alexch skip items missing an href
authored Nov 21, 2011
81 * take items in Ridllr's "Shared Items" public tag and mark them as broadcast
82
f033c21 @alexch notes
authored Nov 21, 2011
83 * Reorder subscription list: put "Shares" folder at the top
84
85 * New Landing Page
86 * make the old one "/about" or something
5d2754d @alexch /send_to marks the sent item with the broadcast state
authored Nov 21, 2011
87 * signed in?
88 1. add 'Send To' link unless already in there
89 2. update your subscriptions
90 * not signed in?
91 1. sign in
92 2. ???
93 3. profit
59a16b2 @alexch misc notes
authored Nov 20, 2011
94
f033c21 @alexch notes
authored Nov 21, 2011
95 * Spam your friends (ask them to join sharebro too)
96
59a16b2 @alexch misc notes
authored Nov 20, 2011
97 * admin page: log
5bd46ea @alexch refactoring, notes, style tweaks, a few notes
authored Nov 14, 2011
98 * save off old shared items (broadcast state JSON)
99 * for all known users? why not?
59a16b2 @alexch misc notes
authored Nov 20, 2011
100 * riddlr-esque features:
101 * https://www.google.com/reader/view/user%2F-%2Flabel%2FPeople%20you%20follow
5d07c81 @alexch skip items missing an href
authored Nov 21, 2011
102
f033c21 @alexch notes
authored Nov 21, 2011
103 * Provide an API for other reader apps
59a16b2 @alexch misc notes
authored Nov 20, 2011
104
f033c21 @alexch notes
authored Nov 21, 2011
105 * Share bookmarklet
106 * look at "min" as a way to strip extranous content from the current page http://min.artequalswork.com/js/m.js
59a16b2 @alexch misc notes
authored Nov 20, 2011
107
f033c21 @alexch notes
authored Nov 21, 2011
108 * update Road Map page
59a16b2 @alexch misc notes
authored Nov 20, 2011
109
632ed98 @alexch misc notes
authored Nov 10, 2011
110 * shared comments
111 * see http://www.salmon-protocol.org/
5bd46ea @alexch refactoring, notes, style tweaks, a few notes
authored Nov 14, 2011
112
f033c21 @alexch notes
authored Nov 21, 2011
113 * make "links" into an RSS feed
114
59a16b2 @alexch misc notes
authored Nov 20, 2011
115 * OPML export
116 * http://www.opml.org/spec
117 * http://www.opml.org/spec2
f033c21 @alexch notes
authored Nov 21, 2011
118
59a16b2 @alexch misc notes
authored Nov 20, 2011
119 * refresh google friends list
12ec7c9 @alexch notes
authored Nov 12, 2011
120
3396c4e @alexch minor auth fix; don't show in-page toc for home2; add Tim to team
authored Dec 6, 2011
121 * add a link to the Google page where users can revoke access tokens (just to make them feel good)
122 * https://accounts.google.com/b/0/IssuedAuthSubTokens
123
5d2754d @alexch /send_to marks the sent item with the broadcast state
authored Nov 21, 2011
124
b6dfa37 @alexch split 'bro' and 'user' widgets more cleanly
authored Nov 11, 2011
125 # TODO (promo)
126
5d2754d @alexch /send_to marks the sent item with the broadcast state
authored Nov 21, 2011
127 * screenshot walkthrough
59a16b2 @alexch misc notes
authored Nov 20, 2011
128 * "spread the word" iconistan sidebar
129 * : +1, FB Like, Tweet, AddToAny by Lockerz, Digg, etc.
130 * http://digg.com/submit?phase=2&url=http%3A%2F%2Fsharebro.org
b6dfa37 @alexch split 'bro' and 'user' widgets more cleanly
authored Nov 11, 2011
131 * add to Chrome Store
044d115 @alexch bugfix and cleanup on sharebros page
authored Nov 12, 2011
132 * write a Safari Extension
133 * http://developer.apple.com/programs/safari/
134 * http://developer.apple.com/membercenter/index.action
be8d7f9 @alexch refactoring, add basic test for bro parsing
authored Nov 11, 2011
135 * reach out to RSS Reader devs
136 * feedly - https://plus.google.com/115552999294763744109
137 * Reeder - Silvio
138 * NewsBlur
19b65c3 @alexch notes, link fixes
authored Nov 12, 2011
139 * HiveMined
05def71 @alexch subscribe to plus posts
authored Nov 25, 2011
140 * Feed Demon
19b65c3 @alexch notes, link fixes
authored Nov 12, 2011
141 * promote & use @sharebro twitter account
142 * make friend with reporters
143 * http://www.readwriteweb.com/archives/author/john-paul-titlow.php
144 * Sarah Perez at TechCrunch
f033c21 @alexch notes
authored Nov 21, 2011
145 * check out addtoany.com -- propose to get their "Reader" link to work again via Sharebro
3396c4e @alexch minor auth fix; don't show in-page toc for home2; add Tim to team
authored Dec 7, 2011
146 * contact people on the Google Support thread and ask them to try sharebro
147 * http://www.google.com/support/forum/p/reader/thread?tid=3ae360cc3912946f&hl=en
148
5d07c81 @alexch skip items missing an href
authored Nov 21, 2011
149
150 # TODO (technical)
151
152 * re-fetch friends list
05def71 @alexch subscribe to plus posts
authored Nov 25, 2011
153 * reconcile google_ids and friends entry counts
5d07c81 @alexch skip items missing an href
authored Nov 21, 2011
154 * catch exceptions in e.g.
155 * http://www.airbrake.io/
156 * exceptional
157 * carefully read http://code.google.com/p/pyrfeed/wiki/GoogleReaderAPI
158 * use https://github.com/rkh/rack-protection if it won't break stuff
159 * refactor Sharebros page to not just use GoogleData
160 * redesign LoveSeat API
c068794 @alexch notes
authored Nov 22, 2011
161 * use or borrow from other ruby greader libs
162 * https://github.com/rstacruz/greader
163 * https://github.com/jnunemaker/googlereader [dead?]
3396c4e @alexch minor auth fix; don't show in-page toc for home2; add Tim to team
authored Dec 7, 2011
164 * examine Atom e.g. http://www.google.com/reader/public/atom/user%2F15504357426492542506%2Fbundle%2FPeople%20you%20follow
165 <link rel="replies" href="http://www.firstthings.com/blogs/firstthoughts/2011/11/25/when-pepper-spray-is-excessive-force/#comments" type="text/html"/>
166 <link rel="replies" href="http://www.firstthings.com/blogs/firstthoughts/2011/11/25/when-pepper-spray-is-excessive-force/feed/atom/" type="application/atom+xml"/>
167
168
Something went wrong with that request. Please try again.