Repository files navigation

⭐ Star us on GitHub — it motivates a lot!

Aimeos is THE ultra-fast, cloud-native andAPI-first headless ecommerce for Laravel! You can adapt, extend, overwriteand customize anything to your needs.

Aimeos is a full-featured e-commerce package:

• JSON REST API based on jsonapi.org
• GraphQL API for administration
• Perfect fit for AWS, Google, Azure and Kubernetes based clouds
• 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
• Subscriptions with recurring payments
• Block/tier pricing out of the box
• Extension for customer/group based prices
• Discount and voucher support
• Flexible basket rule system
• Full-featured admin backend
• Beautiful admin dashboard
• Configurable product data sets
• Completly modular structure
• Extremely configurable and extensible
• Extension for market places with millions of vendors
• Translated to 30+ languages
• Full RTL support
• AI-based text translation
• Secure and reviewed implementation
• High quality source code

... andmore Aimeos features

Supported languages:

Check out the demos:

• Aimeos frontend demo
• Aimeos admin demo

You already have an existing Laravel application and want to add a shop to yourweb site? Install the Aimeos composer package for Laravel and add e-commerce toyour existing application in minutes:

⭐Aimeos Laravel package

If you want to set up a new application or test Aimeos, we recommend the Aimeosshop distribution. It contains everything for a quick start and you will get afully working online shop in less than 5 minutes:

⭐Aimeos shop distribution

• Requirements
• Installation
• Frontend
• Backend
• Customize
• Multi-vendor
• License
• Links

The Aimeos headless distribution requires:

• AWS, Google, Azure or Kubernetes cloud, Linux/Unix, WAMP/XAMP or MacOS environment
• PHP >= 8.2
• 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 missingdependencies.

If you want to upgrade between major versions, please have a look into theupgrade guide!

To install the Aimeos shop application, you needcomposer 2.2+.On the CLI, execute this command for a complete installation including a working setup:

wget https://getcomposer.org/download/latest-stable/composer.phar -O composerphp composer create-project aimeos/aimeos-headless headless

You will be asked for the parameters of your database and mail server as well as ane-mail and password used for creating the administration account.

In a local environment, you can use the integrated PHP web server to test your new Aimeosinstallation. Simply execute the following command to start the web server:

cd headlessphp artisan serve

Note: In an hosting environment, the document root of your virtual host must point tothe/.../headless/public/ directory and you have to change theAPP_URL setting in your.envfile to your domain without port, e.g.:

APP_URL=http://myhostingdomain.com

After the installation, you can test the Aimeos JSON REST API by calling the URL of yourVHost in your browser. If you use the integrated PHP web server, you should browsethis URL:http://127.0.0.1:8000/jsonapi

Learn how to use theJSON REST API

To authenticate using e-mail and password, send a POST request:

curl -X POST"http://127.0.0.1:8000/api/login?email=me@localhost&password=test"

If the authentication was successful, the API will return with a response like this:

{"access_token":"eyJ0eXAiOiJKV...","token_type":"bearer","expires_in":3600}

Use this access token in all further requests as HTTP header:

curl -X POST"http://127.0.0.1:8000/api/me" -H"Authorization: Bearer eyJ0eXAiOiJKV..."

The Aimeos administration interface will be available at/admin in your VHost. When usingthe integrated PHP web server, call this URL:http://127.0.0.1:8000/admin

To use cloud storage like AWS S3 compatible object storages, adapt theresource/fs sectionsin the./config/shop.php file and configure the filesystem like this:

composer req ai-filesystem league/flysystem-aws-s3-v3

'fs' => ['adapter' =>'FlyAwsS3','credentials' => ['key' =>'your-key','secret' =>'your-secret',],'region' =>'your-region','version' =>'latest|api-version','bucket' =>'your-bucket-name','prefix' =>'your-prefix',// optional'baseurl' =>'s3-domain-and-path'],

For Azure Blob storage use:

composer req ai-filesystem league/flysystem-azure-blob-storage

'fs' => ['adapter' =>'FlyAzure','endpoint' =>'DefaultEndpointsProtocol=https;AccountName=your-account;AccountKey=your-api-key','container' =>'your-container','prefix' =>'your-prefix',// optional'baseurl' =>'azure-domain-and-path'],

And for Google Cloud storage:

composer req ai-filesystem league/flysystem-google-cloud-storage

'fs' => ['adapter' =>'FlyGoogleCloud','keyFile' =>json_decode(file_get_contents('/path/to/keyfile.json'),true),// alternative'keyFilePath' =>'/path/to/keyfile.json',// alternative'projectId' =>'myProject',// alternative'prefix' =>'your-prefix'// optional    'baseurl' => 'gcloud-domain-and-path'],

Laravel and the Aimeos headless ecommerce distribution are extremely flexible and highly customizable.A lot of documentation for theLaravel framework and theAimeos ecommerce framework exists. If you have questionsabout Aimeos, don't hesitate to ask in ourAimeos forum.

The Aimeos shop system is licensed under the terms of the MIT and LGPLv3 license andis available for free.

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