Getting started with TYPO3 Flow

A lot of things are going on with the TYPO3 Flow project. While introducing the new CMS Neos and the new naming scheme for the TYPO3 family FLOW3 was renamed to TYPO3 Flow. This name change is also reflected in the code and including the recent switch from Git submodules to Composer getting started with Flow has changed a lot. Too bad that the documentation is outdated. This is a short mini-tutorial to show you how to get Flow on your development machine to get started coding awesome stuff...

The available Getting started tutorial is outdated. Obviously "FLOW3" was simply replaced by "Flow" resulting in some wrong information (incl. the url to the Git repository). A month ago Karsten posted a video on Vimeo showing how to getthe code and all dependencies using Composer. But this was before the renaming.

So here are the simple steps (mostly as seen in Karsten's video) to get started with Flow.

1. Clone the repository to your local machine:

git clone git:// /var/www/flow

The --recursive option is not required anymore as there are not submodules defined. Instead a composer configuration file was added telling composer where to get all dependencies from:

2. Get composer

cd /var/www/flow
curl -s | php    

Download composer using the curl command. If you prefer having composer installed in a central place just download to /usr/local/bin (on Ubuntu and some other Linux).

3. Run composer

./composer.phar install --dev

This will download a dependencies in the correct versions.

4. Set file permissions

sudo ./flow flow:core:setfilepermissions <commandlineuser> <webuser> <webgroup>

Note that the command line tool was renamed from flow3 to flow. Get a full list of available commands by typing ./flow help.

5. Run unit tests

phpunit -c Build/buildessentials/PhpUnit/UnitTests.xml
phpunit -c Build/buildessentials/PhpUnit/FunctionalTests.xml

Phpunit is also available as a single-file phar archive. Run this command to download it:

sudo chmod +x phpunit.phar

However there seems to be a problem with this phar version resulting in errors while executing the tests. Running them with a traditionally installed phpunit works fine.

6. Next steps

Now go on setting up Apache as described in the getting started tutorial and hit Flow in your browser. As soon as you can see the welcome screen you're ready to start coding!

Have fun!



Recent Comments

Zend Certified Engineer (ZCE)
TYPO3 Certified Integrator
Magento Certified Developer PLUS