Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 47 lines (30 sloc) 2.046 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
6 Social networks are the new paradigm on web application design. Social networking platforms stand
7 among the most popular websites, while many content oriented applications support social networking
8 features in order to improve engagement, enhance user awareness and stimulate communities around
9 the website.
10
11 SocialStream is based in {Social Network Analysis}[http://en.wikipedia.org/wiki/Social_network]
12 concepts and methods, including social entities (actors), ties and relations. It provides a
13 new tie-based access control model.
14
15 == Activity Streams
16 {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.
17
18 Social stream provides a database schema based on the {Activity Streams specification}[http://activitystrea.ms/head/activity-schema.html], leading your application towards a well-known compatible data model design.
19
20 = Installation
21
22 SocialStream requires Rails 3. Install it with:
23
24 rails plugin install http://github.com/atd/social_stream.git
25
26 And run:
27
28 rails generate social_stream:install
29
30 This will generate a migration providing the SocialStream database schema and create a configuration
31 file for SocialStream.
32
33 == Actors and ActivityObjects
34
35 SocialStream relies in other authentication solutions like
36 Authlogic[http://github.com/binarylogic/authlogic] or Devise[http://github.com/plataformatec/devise].
37
38 You must include an <tt>actor_id</tt> column in the migration. Then add your model to
39 <tt>config/initializers/social_stream.rb</tt>
40
41 You must do the same with ActivityObjects, like posts, comments or photos. Don't forget to add
42 a <tt>activity_object_id</tt> column in the migration and add them to the initializer.
43
44 = Discussion
45
46 SocialStream is in an early stage of development. Feel free to add an issue or send a message.
Something went wrong with that request. Please try again.