Permalink
Browse files

SocialStream::Base

  • Loading branch information...
1 parent 104a8d0 commit fe3214c2627249cbb13b851d56d43ec5f9131ce5 @atd atd committed Jun 1, 2011
Showing 448 changed files with 135 additions and 147 deletions.
View
@@ -8,5 +8,5 @@ nbproject
.project
.DS_Store
.yardoc/*
-lib/generators/social_stream/templates/public/images/tmp/
+lib/generators/social_stream/base/templates/public/images/tmp/
**.*swp
View
@@ -1,43 +1,35 @@
-= Social Stream: core for building social network websites
-Social Stream is an engine for Ruby on Rails. It provides a robust and flexible core
-with social networking features and activity streams for building websites.
+= Social Stream Base
-== Social networking
-Social networks are a new paradigm on web application design. Social networking platforms stand
-among the most popular websites, while many content oriented applications are supporting social
-networking features in order to improve engagement, enhance user awareness and stimulate communities
-around the website.
+Social Stream Base provides the basic functionality for
+{Social Stream}[http://social-stream.dit.upm.es/], the core for building social
+network websites. The features of this gem are limited, for a complete social
+network environment see https://github.com/ging/social_stream
-{Social Stream}[http://github.com/ging/social_stream] is based on
-{social network analysis (SNA)}[http://en.wikipedia.org/wiki/Social_network] concepts and methods,
-including social entities (actors), ties and relations. Social Stream is so flexible that you can
-define custom actors (groups, organizations, institutions, social events) and relationships
-(friends, collegues, members, administrators, contributors, attendants, speakers).
+== Features
-It also provides a new tie-based access control model, which grants rights at the relation level,
-allowing you to share activities with friends, administrators, members or everybody.
-
-== Activity Streams
-{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.
-
-{Social Stream}[http://github.com/ging/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. It is extensible so you can
-add your own activities easily.
+* Social network infraestructure
+* Activity streams infraestructure
+* Subjects: {User} and {Group}
+* Objects: {Post} and {Commment}
+* Private messages and notifications, by {Mailboxer}[https://github.com/ging/mailboxer]
+* Avatars, by {Avatars For Rails}[https://github.com/ging/avatars_for_rails]
= Installation
+This will install Social Stream basic functionalities. For a complete social network
+platform see {Social Stream}[https://github.com/ging/social_stream]
+
Add to your Gemfile:
- gem 'social_stream'
+ gem 'social_stream-base'
and run:
bundle update
Then:
- rails generate social_stream:install
+ rails generate social_stream:base:install
This will generate the following:
* A jquery:install generation for jQuery support
@@ -53,7 +45,8 @@ Do not forget to migrate your database
== Actors and Activity Objects
-{Social Stream}[http://github.com/ging/social_stream] relies in Devise[http://github.com/plataformatec/devise].
+{Social Stream Base}[https://github.com/ging/social_stream-base] relies in
+Devise[https://github.com/plataformatec/devise].
You have authenticated users support in your application by default.
Besides, there is another kind of actor: groups. If you want other type of actor
@@ -67,9 +60,9 @@ initializer.
= Documentation
-{Social Stream documentation is available at rdoc.info}[http://rubydoc.info/gems/social_stream/frames]
+{Social Stream Base documentation is available at rdoc.info}[http://rubydoc.info/gems/social_stream-base/frames]
= Discussion
-It is at an early stage of development.
-Feel free to add an issue or send a message at github[http://github.com/ging/social_stream].
+We are reaching beta phase of development.
+Feel free to add an issue or send a message at github[https://github.com/ging/social_stream-base].
View
@@ -10,7 +10,7 @@ require 'ci/reporter/rake/rspec'
require 'bundler'
-require File.join(File.dirname(__FILE__), 'lib', 'social_stream', 'version')
+require File.join(File.dirname(__FILE__), 'lib', 'social_stream', 'base', 'version')
RSpec::Core::RakeTask.new(:spec)
@@ -19,7 +19,7 @@ task :default => :spec
Rake::RDocTask.new(:rdoc) do |rdoc|
rdoc.rdoc_dir = 'rdoc'
- rdoc.title = 'SocialStream'
+ rdoc.title = 'SocialStream Base'
rdoc.options << '--line-numbers' << '--inline-source'
rdoc.rdoc_files.include('README.rdoc')
rdoc.rdoc_files.include('lib/**/*.rb', 'app/**/*.rb')
@@ -1,9 +0,0 @@
-Description:
- Initial migration and configuration
-
-Example:
- rails generate social_stream:install
-
- This will create:
- config/initializers/social_stream.rb
- db/migrate/social_stream.rb migration
@@ -1,4 +1,4 @@
-class SocialStream::InstallGenerator < Rails::Generators::Base #:nodoc:
+class SocialStream::Base::InstallGenerator < Rails::Generators::Base #:nodoc:
include Rails::Generators::Migration
hook_for :taggings, :as => :migration
Oops, something went wrong.

0 comments on commit fe3214c

Please sign in to comment.