Skip to content

FriendsOfTYPO3/kickstarter

Repository files navigation

TYPO3 Extension Kickstarter

kickstarter is a TYPO3 extension that simplifies and accelerates the creation of new TYPO3 extensions by automating file generation, controller setup, and plugin registration through easy-to-use CLI commands. With a few CLI commands, it generates essential files like LICENSE, ext_emconf.php,composer.json, and more. Whether starting from scratch or extending existing functionality, kickstarter helps streamline development.


Features

  • Generate New TYPO3 Extensions Automates the creation of TYPO3 extensions with pre-configured files.

  • CLI Commands for Common Tasks

    • Create a new extension
    • Generate controllers (extbase and native)
    • Register plugins (extbase and native)
    • Extend existing controllers with additional actions.
    • Create basic TCA for tables
    • Create extbase domain model
    • Create extbase domain repository
    • Create extbase type converters
    • Create event
    • Create event listener
    • Create testing environment

Installation

Install the extension using Composer:

composer req --dev friendsoftypo3/kickstarter

For DDEV:

ddev composer req --dev friendsoftypo3/kickstarter

Configuration

By default, new extensions are created in typo3temp/kickstarter/[your_ext_key].

To change this location:

  • Navigate to TYPO3 Backend → Admin Tools → Settings → Configure Extensions → kickstarter.
  • For Composer-based installations, the recommended directory is packages/.

Usage

After installation, you can use the following CLI commands:

Create a New Extension

vendor/bin/typo3 make:extension

DDEV:

ddev typo3 make:extension

Warning: This command will ask you to delete an existing extension in the target directory before creating a new one.

Generate a Controller

vendor/bin/typo3 make:controller

DDEV:

ddev typo3 make:controller

You will be prompted to select controller actions. Existing actions will not be overwritten.

Create and Register an Extbase Plugin

vendor/bin/typo3 make:plugin

DDEV:

ddev typo3 make:plugin

Create a TCA table

vendor/bin/typo3 make:table

DDEV:

ddev typo3 make:table

Add testing environment

vendor/bin/typo3 make:testenv

DDEV:

ddev typo3 make:testenv

Create an Event Listener

vendor/bin/typo3 make:eventlistener

DDEV:

ddev typo3 make:eventlistener

Create an Extbase Model

vendor/bin/typo3 make:model

DDEV:

ddev typo3 make:model

Create an Extbase Repository

vendor/bin/typo3 make:repository

DDEV:

ddev typo3 make:repository

Create an Extbase Type Converter

vendor/bin/typo3 make:typeconverter

DDEV:

ddev typo3 make:typeconverter

Create an Upgrade Wizard

vendor/bin/typo3 make:upgrade

DDEV:

ddev typo3 make:upgrade

Why Use kickstarter

Creating TYPO3 extensions often involves repetitive tasks like setting up configuration files and controllers. kickstarter automates these steps, saving time and ensuring a consistent structure.


Special Thanks

Special thanks to LiteGraph for their awesome JS UI library we are using in TYPO3 backend.


Contributions & Feedback

Feedback and contributions are always welcome! Feel free to share your ideas or report issues in the GitHub repository.


About

Very simple extension kickstarter to create TYPO3 based extensions

Resources

License

Contributing

Stars

Watchers

Forks

Packages

No packages published

Contributors 6