Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 111 lines (68 sloc) 4.945 kB
73aca58 @couch Initial Commit
couch authored
1 ## Ospriet — An example audience moderation app built on Twitter
2
3 [Ospriet](http://twitter.github.com/ospriet) is a moderation tool that allows for audiences to post and vote on questions/comments for talks, presentations, and events. The application is written in [node.js](http://nodejs.org/), uses [MongoDB](http://www.mongodb.org/) for database storage, and is designed for deployment on [nodejitsu](http://nodejitsu.com/).
4
5 ## Motivations
6
7 Why open source it?
8
9 * Several people asked for the source after SXSW 2012 to implement the application for their own use
10 * The app serves as a good example of building upon the Twitter platform
11 * Everyone can now use it and help improve the code base
12
13 You can view an example of the site powered by the application used at a 2012 SXSW panel at [http://designfromthegut.com](http://designfromthegut.com).
14
15 For more information on the origins of the application, read [this post](http://couch.tumblr.com/post/18854314402).
16
17 ## Overview
18
19 Ospriet allows anyone with a Twitter account to submit a question or comment, by posting an @-reply to a Twitter account dedicated for an audience-oriented event. The submission will be reposted to the event's account, with attribution. Audience members can vote up the best submissions by favoriting the submissions on the event account. Ospriet will then keep track of all of the favorites and provide the top submissions. Ospriet provides one single, simple interface for all of this that audience members can use on most devices.
20
21 As an example, let's take the event account of <a href="https://twitter.com/dftg">@dftg</a> and submit a question.
22
23 @dftg: What are your thoughts on Apple’s approach to design?
24
25 This tweet will be reposted by the application to <a href="https://twitter.com/dftg">@dftg</a> as an @-reply to your submission, and look like this:
26
27 From @couch: What are your thoughts on Apple's approach to design?
28
29 Anyone can then favorite that reposted tweet, and see the top favorited submissions on the site.
30
31 ## Setup
32
33 Please refer to these wiki pages to download, customize, and deploy your own instance of Ospriet.
34
35 * [Creating your development environment](https://github.com/twitter/ospriet/wiki/Creating-your-development-environment)
36 * [Creating a Twitter app](https://github.com/twitter/ospriet/wiki/Creating-a-Twitter-app)
37 * [Customizing Ospriet](https://github.com/twitter/ospriet/wiki/Customizing-Ospriet)
38 * [Testing Opsriet](https://github.com/twitter/ospriet/wiki/Testing-Ospriet)
39 * [Working with nodejitsu](https://github.com/twitter/ospriet/wiki/Working-with-nodejitsu)
40
41 ## Libraries
42
43 **Server-side**
44
45 - [Matador](http://obvious.github.com/matador) _for MVC app structure_
46 - [ntwitter](http://github.com/avianflu/ntwitter) _node.js wrapper for Twitter API_
47 - [mongoose](http://mongoosejs.com/) _node.js wrapper for MongoDB_
48 - [socket.io](http://socket.io) _for real-time updating of client-side UI_
49
50 **Client-side**
51
52 - [Bootstrap](http://twitter.github.com/bootstrap) _for skeletal layout and micro-jQuery plugins_
53 - [underscore.js](http://documentcloud.github.com/underscore) _for client-side data manipulation_
54 - [hogan.js](http://twitter.github.com/hogan.js) _for template rendering_
55 - [Twitter Web Intents](https://dev.twitter.com/docs/intents) _for tweet actions without authentication_
56
57 ## Screenshots
58
59 **Main index view**
60 <br/>
61 <img src="http://twitter.github.com/ospriet/images/index.jpg" title="Ospriet primary view" alt="Ospriet primary view" width="500" />
62 <br/>
63
64 **Presentation view for projector/screens**
65 <br/>
66 <img src="http://twitter.github.com/ospriet/images/display.jpg" title="Ospriet presentation view" alt="Ospriet presentation view" width="500" />
67 <br/>
68
69 **Responsive layout for mobile**
70 <br/>
71 <img src="http://twitter.github.com/ospriet/images/iphone.jpg" title="Ospriet mobile view" alt="Ospriet mobile view" width="300" />
72 <br/>
73
74 ## Issues and Contributions
75
76 Have a bug or contribution? Create an issue here on GitHub!
77
78 [https://github.com/twitter/ospriet/issues](https://github.com/twitter/ospriet/issues)
79
80 ## Versioning
81
82 For transparency and insight, releases will be numbered with the follow format:
83
84 <major>.<minor>.<patch>
85
86 And constructed with the following guidelines:
87
88 * Breaking backwards compatibility bumps the major
89 * New additions without breaking backwards compatibility bumps the minor
90 * Bug fixes and misc changes bump the patch
91
92 For more information on semantic versioning, please visit http://semver.org/.
93
94
95 ## Authors
96
97 **Bill Couch**
98
99 + [https://github.com/couch](https://github.com/couch)
100 + [https://twitter.com/couch](https://twitter.com/couch)
101
102 **Dustin Senos**
103
104 + [https://github.com/dustinsenos](https://github.com/dustinsenos)
105 + [https://twitter.com/dustin](https://twitter.com/dustin)
106
107 ## License
108
109 Copyright 2012 Twitter, Inc.
110
111 Licensed under the Apache License, Version 2.0: [http://www.apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0)
Something went wrong with that request. Please try again.