<commit_before>= Social Stream: a framework for building social network websites

Social Stream is an engine for Ruby on Rails. It provides a robust and flexible framework
with {social networking}[http://en.wikipedia.org/wiki/Social_network] features and {activity streams}[http://activitystrea.ms/] for building websites.

{<img src="https://secure.travis-ci.org/ging/social_stream.png" />}[http://travis-ci.org/ging/social_stream]
{<img src="https://codeclimate.com/badge.png" />}[https://codeclimate.com/github/ging/social_stream]

= Social Stream components

Social Stream is divided into components. Developers can customize their social
network with the functionalities they need for each case. Current Social Stream distribution include the following components:

* {Base}[https://github.com/ging/social_stream/tree/master/base], basic functionalities of contacts, streams and walls,
  along with users, group, post and comments
* {Documents}[https://github.com/ging/social_stream/tree/master/documents], support for
  activities on files: pictures, audio and video with a HTML5 player
* {Events}[https://github.com/ging/social_stream/tree/master/events], sheduled events with calendar
* {Linkser}[https://github.com/ging/social_stream/tree/master/linkser], advanced management of links to other webpages
* {Presence}[https://github.com/ging/social_stream/tree/master/presence], XMPP based chat support 
* {Ostatus}[https://github.com/ging/social_stream/tree/master/ostatus], support for social network federation
 
= Installation

Add the following to the Gemfile of the your Rails application:

  gem 'social_stream', '>= 1.0.0'

In the case you do not want some functionality, include your desired components instead.
For instance, the Gemfile in an application using documents and links only would contain the following:

  gem 'social_stream-documents'
  gem 'social_stream-linkser'


Then run:

  bundle

Then:

  rails generate social_stream:install

or use specific generators if you are using components.

Do not forget to migrate your database

  rake db:migrate

Since {Social Stream}[http://github.com/ging/social_stream] depends on {Devise}[https://github.com/plataformatec/devise], make sure you follow {its setup instructions}[https://github.com/plataformatec/devise/tree/master/lib/generators/templates#readme]. Specifically, make sure you set the default URL options for your environments at <tt>config/environments/*.rb</tt> with something like:

  config.action_mailer.default_url_options = { :host => 'localhost:3000' }

Social Stream is not compatible with {default mass attributes protection shipped with Rails 3.2.3}[http://weblog.rubyonrails.org/2012/3/30/ann-rails-3-2-3-has-been-released/], but uses the {strong_parameters gem}[https://github.com/rails/strong_parameters] that will be the default in Rails 4.

You must set 
   
   config.active_record.whitelist_attributes = false in config/application.rb


= Documentation

{Social Stream documentation is available at rdoc.info}[http://rubydoc.info/gems/social_stream/frames]

However, most of the documentation is in {the base gem}[http://rubydoc.info/gems/social_stream-base/frames].

= Discussion

Feel free to add an issue at github[https://github.com/ging/social_stream/issues] or drop a message at {Social Stream's Google group}[http://groups.google.com/group/social-stream].<commit_msg>Improve doc<commit_after>= Social Stream: a framework for building social network websites

Social Stream is an engine for Ruby on Rails. It provides a robust and flexible framework
with {social networking}[http://en.wikipedia.org/wiki/Social_network] features and {activity streams}[http://activitystrea.ms/] for building websites.

{<img src="https://secure.travis-ci.org/ging/social_stream.png" />}[http://travis-ci.org/ging/social_stream]
{<img src="https://codeclimate.com/badge.png" />}[https://codeclimate.com/github/ging/social_stream]

= Social Stream components

Social Stream is divided into components. Developers can customize their social
network with the functionalities they need for each case. Current Social Stream distribution include the following components:

* {Base}[https://github.com/ging/social_stream/tree/master/base], basic functionalities of contacts, streams and walls,
  along with users, group, post and comments
* {Documents}[https://github.com/ging/social_stream/tree/master/documents], support for
  activities on files: pictures, audio and video with a HTML5 player
* {Events}[https://github.com/ging/social_stream/tree/master/events], sheduled events with calendar
* {Linkser}[https://github.com/ging/social_stream/tree/master/linkser], advanced management of links to other webpages
* {Presence}[https://github.com/ging/social_stream/tree/master/presence], XMPP based chat support 
* {Ostatus}[https://github.com/ging/social_stream/tree/master/ostatus], support for social network federation
 
= Installation

Add the following to the Gemfile of the your Rails application:

  gem 'social_stream', '>= 1.0.0'

In the case you do not want some functionality, include your desired components instead.
For instance, the Gemfile in an application using documents and links only would contain the following:

  gem 'social_stream-documents'
  gem 'social_stream-linkser'


Then run:

  bundle

Then:

  rails generate social_stream:install

or use specific generators if you are using components.

Do not forget to migrate your database

  rake db:migrate

Since {Social Stream}[http://github.com/ging/social_stream] depends on {Devise}[https://github.com/plataformatec/devise], make sure you follow {its setup instructions}[https://github.com/plataformatec/devise/tree/master/lib/generators/templates#readme]. Specifically, make sure you set the default URL options for your environments at <tt>config/environments/*.rb</tt> with something like:

  config.action_mailer.default_url_options = { :host => 'localhost:3000' }

Social Stream is not compatible with {default mass attributes protection shipped with Rails 3.2.3}[http://weblog.rubyonrails.org/2012/3/30/ann-rails-3-2-3-has-been-released/], but uses the {strong_parameters gem}[https://github.com/rails/strong_parameters] that will be the default in Rails 4.

You must set 
   
   config.active_record.whitelist_attributes = false in config/application.rb


= Documentation

{Social Stream's wiki}[https://github.com/ging/social_stream/wiki] covers topics such as deployment howtos, development tips or an explanation of the database schema.

Furthermore, {Social Stream's code documentation is available at rdoc.info}[http://rubydoc.info/gems/social_stream/frames]. Most of the stuff is in {the base gem}[http://rubydoc.info/gems/social_stream-base/frames].

= Discussion

Feel free to add an issue at github[https://github.com/ging/social_stream/issues] or drop a message at {Social Stream's Google group}[http://groups.google.com/group/social-stream].
{'fraction_non_alphanumeric': 0.10425992779783394, 'fraction_numerical': 0.006353790613718412, 'mean_word_length': 5.102202643171807, 'pattern_counts': {'":': 0, '<': 11, '<?xml version=': 0, '>': 15, 'https://': 27, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 2, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '4384586', 'n_tokens_mistral': 2003, 'n_tokens_neox': 1895, 'n_words': 625}