akeneo-labs / extension-starter
Akeneo PIM extension starter
Installs: 48
Dependents: 0
Suggesters: 0
Security: 0
Stars: 6
Watchers: 6
Forks: 6
Open Issues: 1
Type:symfony-bundle
Requires
- akeneo/pim-community-dev: 1.6.*
- doctrine/migrations: 1.0.0-alpha3@alpha
Requires (Dev)
- friendsofphp/php-cs-fixer: @stable
This package is auto-updated.
Last update: 2024-10-20 22:41:21 UTC
README
[Experimental] Starter kit to quickly setup your own Akeneo PIM Extension
Requirements
Using this starter kit
Context
Our extension is meant to work as part of an existing PIM installation, thus we will use PIM Community Standard Edition to host the connector. This example host container will be at /tmp/pim-standard-edition on our filesystem.
Let's say you work for the WorldCompany and the connector name is WorldExtension. A widely used practice is to use the company name as the root namespace.
COMPANY_NAME=WorldCompany
PIM_PATH=/tmp/pim-standard-edition
EXTENSION_NAME=WorldExtension
Initialisation of the Standard Edition
Create a new host project with the Standard Edition
composer create-project --prefer-dist akeneo/pim-community-standard ${PIM_PATH} "1.5.*@stable"
This will download the standard edition without git informations.
At this point, you have three options to develop your extension:
- work directly in the standard edition src directory
- work in the standard edition src directory via symbolic link
- work in the vendors directory
Workin in the src
directory
In this kind of organization, we will work inside the host project. You can work in this mode when you really start your project from scratch. And when you will have made some commmits, you will probably switch working with a symlink or in the vendor directory.
pim-standard-edition
└── src
└── WorldCompany
├── WorldConnectorExtension.php
├── composer.json
└── ...
The complete process is detailled in the install-standalone.md documentation.
Workin with a symbolic link
TODO
Working in the vendor
directory
If our extension need some composer dependencies, we will have no choice but to work in the vendor
to make it
work with our Standard Edition installation.
Best practices
We maintain an online documentation about [best practices for extensions development] (http://docs.akeneo.com/latest/reference/best_practices/reusable_bundle.html).
## Features checklist We also maintain a checklist of features you should check for a connector or an extension : doc/checklist.md
Other documentation
- Documentation about creating a connector from scratch.
- Do not forget to check the PIM cookbook