= sfBB - a Simple Embedded Forum for Symfony =

== Overview ==

This plugin allows you to embed a forum within your Symfony application.  User management is controlled through 
sfGuard and it is intended that the plugin mature along the same lines as punBB, phpBB and Invision Power Board.

Please note that this plugin is in the early alpha stages of development.

== Requirements ==

sfGuardPlugin has to be installed before you can use this plugin.  See [wiki:sfGuardPlugin] for installation and 
configuation details.  A user profile table is included in the `schema.yml`, which is used by sfGuard in order to 
build up a rich, customised user profile.

The plugin uses Propel but support for Doctrine will be included at a later date.

== Installation ==

Move into your Symfony project directory and install the plugin.

  {{{
  symfony plugin-install http://plugins.symfony-project.com/sfBBPlugin
  }}}

Alternatively, you can install the plugin via SVN.  After moving into your project directory, type:

  {{{
  svn co http://svn.symfony-project.com/plugins/sfBBPlugin/ ./plugins/sfBBPlugin
  }}}

Rebuild your model.

  {{{
  symfony propel-build-all
  }}}

Load the included fixtures.

  {{{
  symfony propel-load-data
  }}}

Enable the sfBB module in your `settings.yml`.

  {{{
  all:
    .settings:
      enabled_modules: [default, ..., sfBB]
  }}}

Add the following rules to your `routing.yml`.

  {{{
  # sfBBPlugin rules
  sf_bb_index:
    url: /sfBB/
    param: { module: sfBB, action: index }

  sf_bb_viewforum:
    url: /sfBB/viewforum/:id/:stripped_name
    param: { module: sfBB, action: viewForum }

  sf_bb_viewpost:
    url: /sfBB/viewpost/:id
    param: { module: sfBB, action: viewPost }

  sf_bb_viewuser:
    url: /sfBB/viewuser/:username
    param: { module: sfBB, action: viewUser }
  }}}

Then, clear your cache.

  {{{
  symfony cc
  }}}

Finally, verify the plugin installation via your web browser.

  {{{
  http://foo.com/sfBB/
  }}}

You're done!

== TO DO ==
viewThread, viewUser, viewPost functionality.
Admin backend.