root/trunk/doc/README

= Welcome to the Symfonians project =

'''Symfonians''' is an open source ([http://creativecommons.org/licenses/by-sa/3.0/ CC-BY-SA 3.0 licensed]) project-centric social networking web application written in [http://php.net/ PHP5] and based on the [http://symfony-framework.org/ Symfony framework] (1.0 stable version is used). The code has been extracted from the [http://symfonians.net/ Symfonians.net] application. 

[[Image(WikiStart:Screenshot.png, align=right)]]

It currently offers several features such as:
 * Applications directory
 * People profiles directory
 * Companies directory
 * Job offers catalog
 * People recommendations
 * Items connections
 * Weblog management
 * Maps and geolocalization
 * Lucene searchable index
 * Microformats
 * and some other features...

As you may have guessed, the main aim of this open source code is not to be set up ''as is'' for running your own website, but to give some ideas for your projects using Symfony.

== Prerequisites ==
PHP5.1+ compiled with `xslt` and `gd2` modules is required (`ImageMagick` would be better, but is not required). All DBMS supported by [http://creole.phpdb.org/trac/ Creole] and [http://propel.phpdb.org/ Propel] are theorically supported (only mysql has been tested), but you'll need to install related php5 modules as needed.

== Installation ==
Checkout the project from the [http://subversion.tigris.org/ subversion] repository:
{{{
$ svn co http://symfonians.org/svn/trunk symfonians-trunk
$ cd symfonians-trunk
}}}

Undistribute all configuration files:
{{{
$ batch/undist.sh
}}}

Then, create a dedicated database (please use UTF-8), undistribute and edit the database configuration files:
{{{
$ vi config/databases.yml config/propel.ini
}}}
You'll find configuration instructions for these two files on the [http://www.symfony-project.org/book/1_0/08-Inside-the-Model-Layer#Database%20Connections dedicated section in the Symfony online documentation].

When you're done, prepare the environment, build the model and load default bundled fixtures:
{{{
$ php symfony fix-perms
$ php symfony propel-build-all
$ php symfony cc
$ php propel-load-data main
$ php batch/post_load.php
}}}

You can do all steps in just a call using:
{{{
$ batch/reinit.sh
}}}

Last, you can edit the `config/app.yml` file (which contains all the params you'd wish to edit to adapt the website to your needs):
{{{
$ vi config/app.yml
}}}

== Apache vhost ==
Make your webserver pointing at the `web` directory of the project, and you're done. Here's a minimal Apache2 vhost sample configuration file (`mod_rewrite` must be enabled):
{{{
NameVirtualHost *
<VirtualHost *>
    ServerName local.symfonians
    DocumentRoot "/path/to/symfonians-trunk/web"
    <Directory "/path/to/symfonians-trunk/web">
        AllowOverride All 
        Allow from All 
    </Directory>
</VirtualHost>
}}}

Add `local.symfonians` entry in your `/etc/hosts` file for your local IP address, reload your webserver and have some rest.

== Licensing information ==
 * This source code is published under the terms of the [http://creativecommons.org/licenses/by-sa/3.0/ CC-BY-SA 3.0] license. It means that if you want to reuse this code source publicly, you must attribute the paternity and redistribute the result under the same terms.

{{{
#!html
<p style="text-align:center">
  <a rel="license" href="http://creativecommons.org/licenses/by-sa/3.0/">
    <img alt="Creative Commons License" style="border-width:0" src="http://i.creativecommons.org/l/by-sa/3.0/88x31.png" />
  </a>
</p>
}}}