Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 57 lines (38 sloc) 2.473 kb
a39cb16 @atd README and LICENSE
atd authored
1 = Social Stream
af370fa @atd Documentation
atd authored
2 Social Stream is a plugin for Ruby on Rails. It provides your application with social networking
3 features and activity streams.
4
5 == Social networking
3d33814 @atd Documentation
atd authored
6 Social networks are a new paradigm on web application design. Social networking platforms stand
7 among the most popular websites, while many content oriented applications are supporting social
8 networking features in order to improve engagement, enhance user awareness and stimulate communities
9 around the website.
af370fa @atd Documentation
atd authored
10
3d33814 @atd Documentation
atd authored
11 {Social Stream}[http://github.com/atd/social_stream] is based in
12 {Social Network Analysis}[http://en.wikipedia.org/wiki/Social_network] concepts and methods,
13 including social entities (actors), ties and relations.
14 It also provides a new tie-based access control model.
af370fa @atd Documentation
atd authored
15
16 == Activity Streams
17 {Activity Streams}[http://activitystrea.ms/] is a format for syndicating social activities around the web. It has already been adopted by some of the major social networking platforms.
18
3d33814 @atd Documentation
atd authored
19 {Social Stream}[http://github.com/atd/social_stream] provides a database schema based on the
20 {Activity Streams specification}[http://activitystrea.ms/head/activity-schema.html], leading your
21 application towards a well-known compatible data model design.
af370fa @atd Documentation
atd authored
22
23 = Installation
24
3d33814 @atd Documentation
atd authored
25 {Social Stream}[http://github.com/atd/social_stream] requires Rails 3. Install it in
26 a Rails application with:
af370fa @atd Documentation
atd authored
27
28 rails plugin install http://github.com/atd/social_stream.git
29
30 And run:
31
32 rails generate social_stream:install
33
3d33814 @atd Documentation
atd authored
34 This will generate a migration providing the Social Stream database schema and create a configuration
af370fa @atd Documentation
atd authored
35 file for SocialStream.
36
3d33814 @atd Documentation
atd authored
37 == Actors and Activity Objects
af370fa @atd Documentation
atd authored
38
3d33814 @atd Documentation
atd authored
39 {Social Stream}[http://github.com/atd/social_stream] relies in other authentication solutions like
af370fa @atd Documentation
atd authored
40 Authlogic[http://github.com/binarylogic/authlogic] or Devise[http://github.com/plataformatec/devise].
41
3d33814 @atd Documentation
atd authored
42 You must include an <tt>actor_id</tt> column in the user's migration. Then add user to
af370fa @atd Documentation
atd authored
43 <tt>config/initializers/social_stream.rb</tt>
44
3d33814 @atd Documentation
atd authored
45 You must do the same with Activity Objects, like posts, comments or photos. Don't forget to add
af370fa @atd Documentation
atd authored
46 a <tt>activity_object_id</tt> column in the migration and add them to the initializer.
47
3d33814 @atd Documentation
atd authored
48 = Documentation
49
50 {Social Stream documentation}[http://rdoc.info/github/atd/social_stream/frames] is available at
51 {rdoc.info}[http://rdoc.info/]
52
af370fa @atd Documentation
atd authored
53 = Discussion
54
3d33814 @atd Documentation
atd authored
55 {Social Stream}[http://github.com/atd/social_stream] is at an early stage of development.
56 Feel free to add an issue or send a message at github[http://github.com/atd/social_stream].
Something went wrong with that request. Please try again.