One Paragraph of project description goes here

These instructions will get you a copy of the project up and running on your local machine for development and

testing purposes. See deployment for notes on how to deploy the project on a live system.

What things you need to install the software and how to install them

Give examples

A step by step series of examples that tell you have to get a development env running

Say what the step will be

Give the example

And repeat

until finished

End with an example of getting some data out of the system or using it for a little demo

Explain how to run the automated tests for this system

The repository contains the TYPO3 extension integrating the Aimeos e-commerce library into TYPO3. The extension provides plugins for e.g. filter, list and detail views, for searching products as well as baskets and the checkout process.

• Installation
  • TER
  • Composer
• TYPO3 setup
  • Extension
  • Database
• Page setup
  • Upload the page tree file
  • Go to the import view
  • Import the uploaded page tree file
• License
• Links

If you want to install Aimeos into your existing TYPO3 installation, the Aimeos extension from the TER is recommended. You can download and install it directly from the Extension Manager of your TYPO3 instance.

For new TYPO3 installations, there's a 1-click Aimeos distribution available too. Choose the Aimeos distribution from the list of available distributions in the Extension Manager and you will get a completely set up shop system including demo data for a quick start.

The latest version can be installed via composer too. This is especially useful if you want to create new TYPO3 installations automatically or play with the latest code. You need to install the composer package first if it isn't already available:

php -r "readfile('https://getcomposer.org/installer');" | php -- --filename=composer

In order to tell composer what it should install, you have to create a basic composer.json file in the directory of you VHost. It should look similar to this one:

{
    "name": "vendor/mysite",
    "description" : "My new TYPO3 web site",
    "minimum-stability": "dev",
    "prefer-stable": true,
    "repositories": [
        { "type": "composer", "url": "https://composer.typo3.org/" }
    ],
    "require": {
        "typo3/cms": "~8.7",
        "aimeos/aimeos-typo3": "dev-master"
    },
    "extra": {
        "typo3/cms": {
            "cms-package-dir": "{$vendor-dir}/typo3/cms",
            "web-dir": "htdocs"
        }
    },
    "scripts": {
        "post-install-cmd": [
            "Aimeos\\Aimeos\\Custom\\Composer::install"
        ],
        "post-update-cmd": [
            "Aimeos\\Aimeos\\Custom\\Composer::install"
        ]
    }
}

It will install TYPO3 and the latest Aimeos TYPO3 extension in the ./htdocs/ directory. Afterwards, the Aimeos composer script will be executed which copies some required files and adds a link to the Aimeos extensions placed in the ./ext/ directory. To start installation, execute composer on the command line in the directory where your composer.json is stored:

composer update

• Log into the TYPO3 back end
• Click on ''Admin Tools::Extension Manager'' in the left navigation
• Click the icon with the little plus sign left from the Aimeos list entry (looks like a lego brick)
• If a pop-up opens (only TYPO3 4.x) choose ''Make updates'' and "Close window" after the installation is done

Caution: Install the RealURL extension before the Aimeos extension to get nice looking URLs. Otherwise, RealURL doesn't rewrite the parameters even if you install RealURL afterwards!

Afterwards, you have to execute the update script of the extension to create the required database structure:

The page setup for an Aimeos web shop is easy if you import the standard page tree into your TYPO3 installation.

• In Web::Page, root page (the one with the globe)
• Right click on the globe
• Move the cursor to "Branch actions"
• In the sub-menu, click on "Import from .t3d"

• In the page import dialog
• Select the "Upload" tab (2nd one)
• Click on the "Select" dialog
• Choose the file you've downloaded
• Press the "Upload files" button

• In Import / Export view
• Select the uploaded file from the drop-down menu
• Click on the "Preview" button
• The pages that will be imported are shown below
• Click on the "Import" button that has appeared
• Confirm to import the pages

Now you have a new page "Shop" in your page tree including all required sub-pages.

The Aimeos TYPO3 extension is licensed under the terms of the GPL Open Source license and is available for free.

• Web site
• Documentation
• Forum
• Issue tracker
• Source code

Explain what these tests test and why

Give an example

Explain what these tests test and why

Give an example

Add additional notes about how to deploy this on a live system

• Dropwizard - The web framework used
• Maven - Dependency Management
• ROME - Used to generate RSS Feeds

Please read CONTRIBUTING.md for details on our code of

conduct, and the process for submitting pull requests to us.

We use SemVer for versioning. For the versions available, see the [tags on this repository]

(https://github.com/your/project/tags).

• Billie Thompson - Initial work - PurpleBooth

See also the list of contributors who participated in this

project.

This project is licensed under the MIT License - see the LICENSE.md file for details

• Hat tip to anyone who's code was used
• Inspiration
• etc