Quick Start: Set up TYPO3

  1. Perform composer install

    Note that we encourage to use the TYPO3 Core runTests.sh runner, and thus do not use a local or DDEV composer command directly:

    Install composer dependencies using default php version
    ./Build/Scripts/runTests.sh -s composerInstall
    Copied!

    Bear in mind: Even though we use composer to install dependencies, the resulting TYPO3 installation will be in Legacy mode, not Composer-Mode. This is still how TYPO3 performs most of its core testing and development.

  2. Set up TYPO3 database

    Note that we perform the setup using the automatable TYPO3 Console, not the Web GUI. All command options use the DDEV configuration conventions, (db:db@db), you do not need to adapt this.

    Setup the instance using the TYPO3 setup command
    ddev exec touch FIRST_INSTALL && \
        ddev typo3 setup \
            --driver=mysqli \
            --host=db \
            --port=3306 \
            --dbname=db \
            --username=db \
            --password=db \
            --admin-username=john-doe \
            --admin-user-password='John-Doe-1701D.' \
            --admin-email="john.doe@example.com" \
            --project-name='TYPO3 Contribution' \
            --no-interaction \
            --server-type=apache \
            --force
    Copied!
    This should result in a message:
    ✓ Congratulations - TYPO3 Setup is done.
    Copied!
  3. Activate EXT:styleguide

    Ensure extension setup and activate required extensions (EXT:styleguide, EXT:indexed_search)
    ddev typo3 extension:setup && \
        ddev typo3 extension:activate indexed_search && \
        ddev typo3 extension:activate styleguide
    Copied!
    Setup all default backend user groups
    ddev typo3 setup:begroups:default --groups=Both
    Copied!
    Create styleguide TCA and FRONTEND page tree
    ddev typo3 styleguide:generate --create -- tca && \
        ddev typo3 styleguide:generate --create -- frontend-systemplate
    Copied!
    Which should give this output:
    [OK] Extension(s) "core, filelist, frontend, impexp, lowlevel, form, extbase, fluid, fluid_styled_content, install,
        reports, redirects, setup, rte_ckeditor, adminpanel, backend, belog, beuser, dashboard, extensionmanager, felogin,
        info, seo, sys_note, tstemplate, viewpage" successfully set up.
    [OK] Activated extension styleguide successfully.
    [OK] Backend user group(s) created: Editor, Advanced Editor
    TCA page tree created!
    Frontend page tree created!
    Copied!

    Note there remain some extensions disabled (filemetadata, indexed_search, linkvalidator, opendocs, reactions, recycler, scheduler, webhooks, workspaces). If you plan to work on these, activate them similarly, or use the Extension Manager in the TYPO3 Backend.

  4. Log in to TYPO3

    You should now be able to log in to the TYPO3 backend with the username and password as specified above (john-doe : John-Doe-1701D.) by calling:

    Open up the TYPO3 Backend for the ddev instance
    ddev launch typo3
    Copied!