Build Process

This page documents the steps that a phpCollab developer/contributor should take for building a phpCollab server locally.

Development

Source Checkout

The following shell commands may be used to grab the source from the repository:

git clone git@github.com:phpcollab/phpcollab.git phpcollab

Or a quicker clone:

git clone --depth=1 --single-branch --branch=master git@github.com:phpcollab/phpcollab.git phpcollab
# git fetch --unshallow

For a successful clone, you will need to have set up SSH keys for your account on Github. If that is not an option, you may clone the phpCollab repository under https via https://github.com/phpcollab/phpcollab.git.

Build

The following shell commands may be used to build the source:

cd phpcollab
git checkout master

When done, you may build the codebase via the following command:

./composer install

IDE Setup

phpCollab development may be carried out using any modern IDE.

Plugins

The following plugins may prove useful during development:

• Symfony Plugin
• PHP Annotations

Testing Modules

To test the functionality provided by a given phpCollab module, execute the following steps:

vendor/bin/codecept run

Deploy

Point your web server’s root to the phpCollab folder