Sha256: 3bd658148dc023db39bd435b0bc806bf233407ce31668ca81f05219eafa82442

Contents?: true

Size: 1.32 KB

Versions: 6

Compression:

Stored size: 1.32 KB

Contents

= Soapbox -- a Twitter-style chat app

Soapbox is a chat app written using Faye and jQuery, with functionality
modelled on that of Twitter. You can pick a username, type in some users
to follow, and enter messages. You receive messages from anyone you're
following, and any messages that mention you using the <tt>@username</tt>
syntax.


== Running the demo

There are two backends that handle message routing; one for Node.js
and one for Rack. To run the Node.js version:

  node examples/node/app.js

To run the Rack version you need a few gems first:

  sudo gem install eventmachine rack json sinatra
  rackup -s mongrel examples/rack/config.ru

You can also use Thin to run the app as long as <tt>Rack::Lint</tt>
is not being used (it complains about the status codes Thin uses
for async responses).

  rackup -s thin -E production examples/rack/config.ru

Note that Faye does not depend on Sinatra; the demo just uses it to
provide a concrete app behind the Faye middleware.


== Source code

There is no server-side logic for this app; the Faye server simply
handles message routing between clients and all subscriptions are set
up on the client side. Since this is a simple demo of client-side
messaging, your username and followees are not persisted across page
reloads. The source code for the client is at:

  shared/public/soapbox.js

Version data entries

6 entries across 6 versions & 1 rubygems

Version Path
faye-0.3.4 examples/README.rdoc
faye-0.3.3 examples/README.rdoc
faye-0.3.2 examples/README.rdoc
faye-0.3.1 examples/README.rdoc
faye-0.3.0 examples/README.rdoc
faye-0.2.2 examples/README.rdoc