PHPackages                             aimeos/aimeos-slim - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. aimeos/aimeos-slim

AbandonedArchivedLibrary

aimeos/aimeos-slim
==================

Professional, full-featured and ultra fast SlimPHP e-commerce package for (TV-approved) online shops

2020.01.1(6y ago)9784120LGPL-3.0-or-laterPHPPHP &gt;=5.4.0

Since Jul 13Pushed 6y ago12 watchersCompare

[ Source](https://github.com/aimeos/aimeos-slim)[ Packagist](https://packagist.org/packages/aimeos/aimeos-slim)[ Docs](https://aimeos.org/SlimPHP)[ RSS](/packages/aimeos-aimeos-slim/feed)WikiDiscussions master Synced 1mo ago

READMEChangelogDependencies (16)Versions (44)Used By (0)

[ ![Aimeos logo](https://camo.githubusercontent.com/e55b7a8426f14ba6040d604746b03b7e096af41ede8fead0ea817cbb8d60f998/68747470733a2f2f61696d656f732e6f72672f66696c6561646d696e2f74656d706c6174652f69636f6e732f6c6f676f2e706e67 "Aimeos")](https://aimeos.org/)Aimeos Slim package
===================

[](#aimeos-slim-package)

[![Total Downloads](https://camo.githubusercontent.com/f643f3e5b205c5c1c8c784a7e0880f39c369a33e246e011495a6c93af40c8ce9/68747470733a2f2f706f7365722e707567782e6f72672f61696d656f732f61696d656f732d736c696d2f642f746f74616c2e737667)](https://packagist.org/packages/aimeos/aimeos-slim)[![Build Status](https://camo.githubusercontent.com/319022585a138c30db3652e47200279582182966d6d1d7140fcaf1d237bc5163/68747470733a2f2f7472617669732d63692e6f72672f61696d656f732f61696d656f732d736c696d2e737667)](https://travis-ci.org/aimeos/aimeos-slim)[![Coverage Status](https://camo.githubusercontent.com/fb582bf3fe78e38a87ed408012e44b594368af523f50c242e4be8614721991b8/68747470733a2f2f636f766572616c6c732e696f2f7265706f732f61696d656f732f61696d656f732d736c696d2f62616467652e7376673f6272616e63683d6d617374657226736572766963653d676974687562)](https://coveralls.io/github/aimeos/aimeos-slim?branch=master)[![Scrutinizer Code Quality](https://camo.githubusercontent.com/7d279009ac1c9ce0734663db3de6b61b281a0ae50a437815c7ca2ca0c447006b/68747470733a2f2f7363727574696e697a65722d63692e636f6d2f672f61696d656f732f61696d656f732d736c696d2f6261646765732f7175616c6974792d73636f72652e706e673f623d6d6173746572)](https://scrutinizer-ci.com/g/aimeos/aimeos-slim/?branch=master)

⭐ Star us on GitHub — it helps!

[Aimeos](https://aimeos.org/SlimPHP) is THE professional, full-featured and high performance e-commerce package for Laravel! You can install it in your existing SlimPHP application within 5 minutes and can adapt, extend, overwrite and customize anything to your needs.

[![Aimeos SlimPHP demo](https://camo.githubusercontent.com/4cc4e2e8c8624f003fe7c3791b437a0c4b1b4cb91eef7b17d9e083a369ed0676/68747470733a2f2f61696d656f732e6f72672f66696c6561646d696e2f61696d656f732e6f72672f696d616765732f61696d656f732d6769746875622e706e67)](http://slim.demo.aimeos.org/)

Table of content
----------------

[](#table-of-content)

- [Installation/Update](#installation-or-update)
- [Setup](#setup)
- [Admin](#admin)
- [Hints](#hints)
- [License](#license)
- [Links](#links)

Installation or update
----------------------

[](#installation-or-update)

This document is for the latest Aimeos SlimPHP **2019.10 release and later**.

- Beta release: 2020.01
- LTS release: 2019.10

This tutorial assumes a directory layout as used in the Slim skeleton application created by:

`composer create-project slim/slim-skeleton:~3.1 [my-app-name]`

The Aimeos Slim e-commerce package is a composer based library that can be installed easiest by using [Composer](https://getcomposer.org). Add these lines to your `composer.json` of your Slim project:

```
    "prefer-stable": true,
    "minimum-stability": "dev",
    "require": {
        "aimeos/aimeos-slim": "~2019.10",
        ...
    },

```

Afterwards, install the Aimeos shop package using

`composer update`

The next step is to **copy the required configuration and route files** to your `src/`directory so you have your own copy you can modify according to your needs. When you upgrade from a previous version, you should have a backup of these files. You can then reapply the changes you've made in the past to the updated files.

```
cp vendor/aimeos/aimeos-slim/src/aimeos-settings.php src/
cp vendor/aimeos/aimeos-slim/src/aimeos-routes.php src/

```

To configure your database, you have to **adapt the configuration** in `src/aimeos-settings.php`file and modify the settings in the resource section:

```
'resource' => [
    'db' => [
        'adapter' => 'mysql',
        'host' => 'localhost',
        'port' => '',
        'socket' => '',
        'database' => 'slim',
        'username' => 'root',
        'password' => '',
        'stmt' => ["SET SESSION sort_buffer_size=2097144; SET NAMES 'utf8mb4'; SET SESSION sql_mode='ANSI'"],
        'opt-persistent' => 0,
        'limit' => 3,
        'defaultTableOptions' => [
            'charset' => 'utf8mb4',
            'collate' => 'utf8mb4_bin',
        ],
    ],
],
```

If you don't have at least MySQL 5.7 installed, you will probably get an error like

`Specified key was too long; max key length is 767 bytes`

To circumvent this problem, change the charset/collate setting in your `src/aimeos-settings.php` to these values **before installing Aimeos**:

```
'resource' => [
    'db' => [
        // ...
        'defaultTableOptions' => [
            'charset' => 'utf8',
            'collation' => 'utf8_bin'
        ],
    ],
],
```

If you want to use a database server other than MySQL, please have a look into the article about [supported database servers](https://aimeos.org/docs/Developers/Library/Database_support)and their specific configuration.

Setting up or upgrading existing tables in the database is done via:

```
php vendor/aimeos/aimeos-core/setup.php --config=src/aimeos-settings.php --option=setup/default/demo:1

```

In a production environment or if you don't want that the demo data is added, leave out the `--option=setup/default/demo:1` option.

You must also **copy the Aimeos templates** to the `templates/` directory of your Slim application. Thus, you can modify them according to your needs and they won't be overwritten by the next composer update:

```
cp -r vendor/aimeos/aimeos-slim/templates/* templates/

```

The last step is to **publish the Aimeos theme files** to the `public/` directory, so they are available via HTTP:

```
mkdir -p public/aimeos/themes/
cp -r vendor/aimeos/aimeos-slim/resources/mimeicons/ public/aimeos/
cp -r ext/ai-client-html/client/html/themes/* public/aimeos/themes/
cp -r ext/ai-admin-jqadm/admin/jqadm/themes/* public/aimeos/themes/

```

Setup
-----

[](#setup)

Aimeos requires some objects to be available (like the Aimeos context) and the routes for generating the URLs. Both are added automatically if you **add the lines starting with $aimeos** right after the `$app = new \Slim\App($settings);` statement in your `public/index.php` file:

```
$app = new \Slim\App($settings);

$aimeos = new \Aimeos\Slim\Bootstrap( $app, require '../src/aimeos-settings.php' );
$aimeos->setup( '../ext' )->routes( '../src/aimeos-routes.php' );

// Set up dependencies
```

The Aimeos Slim package uses the Twig template engine to render the templates. Therefore, you have to **setup the view object** with a configured Twig instance. Copy the lines below at the end of your `src/dependencies.php` file:

```
// Twig view + Aimeos templates
$container['view'] = function ($c) {
	$conf = ['cache' => '../cache'];
	$view = new \Slim\Views\Twig(__DIR__ . '/../templates', $conf);
	$view->addExtension(new \Slim\Views\TwigExtension($c->get('router'), $c->get('request')->getUri()));
	return $view;
};
```

Note: You can use the Slim PHP template engine as well if you reimplement the existing templates in PHP, but Twig has one major advantage: Templates can inherit from a common base template, so you don't have to copy the whole HTML page into each template.

**Caution:** The Slim skeleton application contain a route for `/[{name}]` in `src/routes.php`which you have to remove first. It's so generic that it shadows routes from Aimeos!

Then, you should be able to call the catalog list page in your browser. For a quick start, you can use the integrated web server that is available since PHP 5.4. Simply execute this command in the base directory of your application:

`php -S 127.0.0.1:8000 -t public`

Point your browser to the list page of the shop using:

Since 2019.04: Until 2019.01:

Admin
-----

[](#admin)

The Aimeos package for the Slim PHP framework also contains an administration interface for managing products and other content. If the internal PHP web server (`php -S 127.0.0.1:8000 -t public`) is still running, you can find it at:

**Caution:** It's important to protect the administration interface with a password or some other kind of authentication!

The easiest way is to add HTTP basic authentication (the browser is asking for user name and password) to all `/admin` URLs. In Slim, there's a middleware which you can add to your application. To install it, execute

`composer require tuupola/slim-basic-auth`

on the command line in your application directory. Afterwards, adapt your `public/index.php` file and add these lines before `$app->run()`:

```
$app->add(new \Tuupola\Middleware\HttpBasicAuthentication([
	"realm" => "Aimeos administration",
	"path" => "/admin",
	"users" => [
		"admin" => "secret",
	],
]));
```

**Note:** The "users" array can contain a list of user name / password combinations and you need to use a **really secret password**!

Hints
-----

[](#hints)

To simplify development, you should configure to use no content cache. You can do this in the `src/aimeos-settings.php` file of your Slim application by adding these lines at the bottom:

```
    'madmin' => array(
        'cache' => array(
            'manager' => array(
                'name' => 'None',
            ),
        ),
    ),
```

If caching is enabled, you have to execute the following command to clear the cache if you change e.g. configuration settings:

```
php vendor/aimeos/aimeos-slim/cache.php --config=src/aimeos-settings.php

```

License
-------

[](#license)

The Aimeos Slim package is licensed under the terms of the LGPLv3 license and is available for free.

Links
-----

[](#links)

- [Web site](https://aimeos.org/)
- [Documentation](https://aimeos.org/docs/)
- [Forum](https://aimeos.org/help/)
- [Issue tracker](https://github.com/aimeos/aimeos-slim/issues)
- [Composer packages](https://packagist.org/packages/aimeos/aimeos-slim)
- [Source code](https://github.com/aimeos/aimeos-slim)

###  Health Score

38

—

LowBetter than 85% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity31

Limited adoption so far

Community17

Small or concentrated contributor base

Maturity71

Established project with proven stability

 Bus Factor1

Top contributor holds 98.7% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~32 days

Recently: every ~49 days

Total

41

Last Release

2308d ago

Major Versions

2016.10.4 → 2017.04.22017-05-22

2017.10.1 → 2018.01.12018-01-08

2017.10.x-dev → 2018.04.12018-04-11

2018.10.x-dev → 2019.01.12019-01-09

2019.10.x-dev → 2020.01.12020-01-14

PHP version history (3 changes)2016.07.1PHP &gt;=5.3.3

2017.10.1PHP &gt;=5.4.0

2019.04.1PHP &gt;=5.5.0

### Community

Maintainers

![](https://www.gravatar.com/avatar/ccdc84033584516c77fb6aa7f85dc7048f2fbcd08867fc6abf115d094bab5eef?d=identicon)[aimeos](/maintainers/aimeos)

---

Top Contributors

[![aimeos](https://avatars.githubusercontent.com/u/8647429?v=4)](https://github.com/aimeos "aimeos (234 commits)")[![scrutinizer-auto-fixer](https://avatars.githubusercontent.com/u/6253494?v=4)](https://github.com/scrutinizer-auto-fixer "scrutinizer-auto-fixer (3 commits)")

---

Tags

aimeose-commerceecommercejson-apiperformancephpshopslim-php-frameworkslimshopecommerceslimphpe-commerceaimeostv

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/aimeos-aimeos-slim/health.svg)

```
[![Health](https://phpackages.com/badges/aimeos-aimeos-slim/health.svg)](https://phpackages.com/packages/aimeos-aimeos-slim)
```

###  Alternatives

[aimeos/aimeos-typo3

Professional, full-featured and high performance TYPO3 e-commerce extension for online shops and complex B2B projects

1.5k91.2k4](/packages/aimeos-aimeos-typo3)[aimeos/aimeos-symfony

Professional, full-featured and high performance Symfony e-commerce bundle for online shops and complex B2B projects

1.4k4.3k](/packages/aimeos-aimeos-symfony)[aimeos/aimeos-laravel

Cloud native, API first Laravel eCommerce package with integrated AI for ultra-fast online shops, marketplaces and complex B2B projects

8.6k214.7k3](/packages/aimeos-aimeos-laravel)[aimeos/ai-cms-grapesjs

Aimeos GrapesJS CMS extension

970106.9k1](/packages/aimeos-ai-cms-grapesjs)[aimeos/ai-laravel

Laravel adapter for Aimeos e-commerce integration

971228.8k2](/packages/aimeos-ai-laravel)[aimeos/ai-typo3

TYPO3 adapter for Aimeos e-commerce integration

95392.1k1](/packages/aimeos-ai-typo3)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)
