:star: Star us on GitHub — it motivates us a lot! 😀
Aimeos is THE professional, full-featured and
ultra fast Laravel ecommerce package! You can install it in your
existing Laravel application within 5 minutes and can adapt, extend, overwrite
and customize anything to your needs.
Features
Aimeos is a full-featured e-commerce package:
Multi vendor, multi channel and multi warehouse
From one to 1,000,000,000+ items
Extremly fast down to 20ms
For multi-tentant e-commerce SaaS solutions with unlimited vendors
Bundles, vouchers, virtual, configurable, custom and event products
If you want to set up a new application or test Aimeos, we recommend the Aimeos
shop distribution. It contains everything for a quick start and you will get a
fully working online shop in less than 5 minutes:
If you want to build a single page application (SPA) respectively a progressive web
application (PWA) yourself and don't need the Aimeos HTML frontend, then the Aimeos
headless distribution is the right choice:
Currently, the Aimeos Laravel packages 2024.10 and later are fully supported:
LTS release: 2025.10+ (Laravel 10.x, 11.x and 12.x)
old LTS release: 2024.10+ (Laravel 10.x and 11.x)
If you want to upgrade between major versions, please have a look into the
upgrade guide!
Requirements
The Aimeos shop distribution requires:
Linux/Unix, WAMP/XAMP or MacOS environment
PHP >= 8.1
MySQL >= 5.7.8, MariaDB >= 10.2.2, PostgreSQL 9.6+, SQL Server 2019+
Web server (Apache, Nginx or integrated PHP web server for testing)
If required PHP extensions are missing, composer will tell you about the missing
dependencies.
If you want to upgrade between major versions, please have a look into the
upgrade guide!
Database
Make sure that you've created the database in advance and added the configuration
to the .env file in your application directory. Sometimes, using the .env file makes
problems and you will get exceptions that the connection to the database failed. In that
case, add the database credentials to the resource/db section of your ./config/shop.php
file too!
If you don't have at least MySQL 5.7.8 or MariaDB 10.2.2 installed, you will probably get an error like
Specified key was too long; max key length is 767 bytes
To circumvent this problem, drop the new tables if there have been any created and
change the charset/collation setting in ./config/database.php to these values before
installing Aimeos again:
Caution: Also make sure that your MySQL server creates InnoDB tables by default as MyISAM
tables won't work and will result in an foreign key constraint error!
If you want to use a database server other than MySQL, please have a look into the article about
supported database servers
and their specific configuration. Supported are:
MySQL, MariaDB (fully)
PostgreSQL (fully)
SQL Server (fully)
Make sure, you use one of the supported database servers in your .env file, e.g.:
Caution: The SQLite database configured by default is NOT supported!
Installation
The Aimeos Laravel online shop package is a composer based library. It can be
installed easiest by using Composer 2.1+ in the root
directory of your existing Laravel application:
In a production environment or if you don't want that the demo data gets
installed, leave out the --option=setup/default/demo:1 option.
Authentication
You have to set up one of Laravel's authentication starter kits. Laravel Breeze
is the easiest one but you can also use Jetstream.
composer require laravel/breeze
php artisan breeze:install
npm install && npm run build # if not executed automatically by the previous command
Laravel Breeze will ask you a few questions, the most important one is the type of stack you
want to use. Select "Blade" (it's the easiest way) and use the default values for the others.
It also adds a route for /profile to ./routes/web.php which may overwrite the
aimeos_shop_account route. To avoid an exception about a missing aimeos_shop_account
route, change the URL for these lines from ./routes/web.php file from /profile to
/profile/me:
As a last step, you need to extend the boot() method of your
App\Providers\AppServiceProvider class and add the lines to define how
authorization for "admin" is checked in app/Providers/AppServiceProvider.php:
public function boot()
{
// Keep the lines before
\Illuminate\Support\Facades\Gate::define('admin', function($user, $class, $roles) {
if( isset( $user->superuser ) && $user->superuser ) {
return true;
}
return app( '\Aimeos\Shop\Base\Support' )->checkUserGroup( $user, $roles );
});
}
Create account
Test if your authentication setup works before you continue. Create an admin account
for your Laravel application so you will be able to log into the Aimeos admin interface:
php artisan aimeos:account --super <email>
The e-mail address is the user name for login and the account will work for the
frontend too. To protect the new account, the command will ask you for a password.
The same command can create limited accounts by using --admin, --editor or --api
instead of --super (access to everything).
Setup
To reference images correctly, you have to adapt your .env file and set the APP_URL
to your real URL, e.g.
APP_URL=http://127.0.0.1:8000
Caution: Make sure, Laravel uses the file session driver in your .env file!
Otherwise, the shopping basket content won't get stored correctly!
SESSION_DRIVER=file
If your ./public directory isn't writable by your web server, you have to create these
directories:
In a production environment, you should be more specific about the granted permissions!
Test
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. Simply execute this command
in the base directory of your application:
php artisan serve
Frontend
Point your browser to the list page of the shop using:
http://127.0.0.1:8000/shop/search
Note: Integrating the Aimeos package adds some routes like /shop or /admin to your
Laravel installation but the home page stays untouched! If you want to add Aimeos to
the home page as well, replace the route for "/" in ./routes/web.php by this line:
Route::group(['middleware' => ['web']], function () {
Route::get('/', '\Aimeos\Shop\Controller\CatalogController@homeAction')->name('aimeos_home');
});
For multi-vendor setups, read the article about multiple shops.
This will display the Aimeos catalog home component on the home page you you get a
nice looking shop home page which will look like this:
Backend
If you've still started the internal PHP web server (php artisan serve)
you should now open this URL in your browser:
http://127.0.0.1:8000/admin
Enter the e-mail address and the password of the newly created user and press "Login".
If you don't get redirected to the admin interface (that depends on the authentication
code you've created according to the Laravel documentation), point your browser to the
/admin URL again.
Caution: Make sure that you aren't already logged in as a non-admin user! In this
case, login won't work because Laravel requires you to log out first.
Hints
To simplify development, you should configure to use no content cache. You can
do this in the config/shop.php file of your Laravel application by adding
these lines at the bottom:
