{"id":13401868,"url":"https://github.com/aimeos/aimeos-headless","last_synced_at":"2025-10-05T18:52:45.701Z","repository":{"id":38372280,"uuid":"432180204","full_name":"aimeos/aimeos-headless","owner":"aimeos","description":"Aimeos cloud-native, API-first ecommerce headless distribution based on Laravel 11 for ultra fast online shops, scalable marketplaces, complex B2B applications and #gigacommerce","archived":false,"fork":false,"pushed_at":"2025-07-23T17:07:58.000Z","size":2829,"stargazers_count":2111,"open_issues_count":3,"forks_count":25,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-09-01T05:30:12.647Z","etag":null,"topics":["api","cloud","ecommerce","ecommerce-api","ecommerce-framework","ecommerce-platform","headless","laravel","microservice","php","shop","vue"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/aimeos.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2021-11-26T13:00:29.000Z","updated_at":"2025-09-01T05:22:31.000Z","dependencies_parsed_at":"2024-06-17T23:07:29.273Z","dependency_job_id":"33de4aae-5575-4ab9-a5cb-ae0453df771e","html_url":"https://github.com/aimeos/aimeos-headless","commit_stats":{"total_commits":53,"total_committers":3,"mean_commits":"17.666666666666668","dds":0.1132075471698113,"last_synced_commit":"28c58ec9f5d00c361fcc2d2c29761d26407a49cb"},"previous_names":[],"tags_count":9,"template":false,"template_full_name":null,"purl":"pkg:github/aimeos/aimeos-headless","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aimeos%2Faimeos-headless","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aimeos%2Faimeos-headless/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aimeos%2Faimeos-headless/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aimeos%2Faimeos-headless/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/aimeos","download_url":"https://codeload.github.com/aimeos/aimeos-headless/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aimeos%2Faimeos-headless/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":278503206,"owners_count":25997717,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-05T02:00:06.059Z","response_time":54,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api","cloud","ecommerce","ecommerce-api","ecommerce-framework","ecommerce-platform","headless","laravel","microservice","php","shop","vue"],"created_at":"2024-07-30T19:01:08.294Z","updated_at":"2025-10-05T18:52:45.653Z","avatar_url":"https://github.com/aimeos.png","language":"JavaScript","funding_links":[],"categories":["JavaScript","cloud"],"sub_categories":[],"readme":"\u003ca href=\"https://aimeos.org/\"\u003e\n    \u003cimg src=\"https://aimeos.org/fileadmin/template/icons/logo.png\" alt=\"Aimeos logo\" title=\"Aimeos\" align=\"right\" height=\"60\" /\u003e\n\u003c/a\u003e\n\n# Aimeos headless distribution\n\n:star: Star us on GitHub — it motivates a lot!\n\n[Aimeos](https://aimeos.org/Laravel) is THE ultra-fast, cloud-native and\nAPI-first headless ecommerce for Laravel!  You can adapt, extend, overwrite\nand customize anything to your needs.\n\n## Features\n\nAimeos is a full-featured e-commerce package:\n\n* JSON REST API based on jsonapi.org\n* GraphQL API for administration\n* Perfect fit for AWS, Google, Azure and Kubernetes based clouds\n* Multi vendor, multi channel and multi warehouse\n* From one to 1,000,000,000+ items\n* Extremly fast down to 20ms\n* For multi-tentant e-commerce SaaS solutions with unlimited vendors\n* Bundles, vouchers, virtual, configurable, custom and event products\n* Subscriptions with recurring payments\n* Block/tier pricing out of the box\n* Extension for customer/group based prices\n* Discount and voucher support\n* Flexible basket rule system\n* Full-featured admin backend\n* Beautiful admin dashboard\n* Configurable product data sets\n* Completly modular structure\n* Extremely configurable and extensible\n* Extension for market places with millions of vendors\n* Translated to 30+ languages\n* Full RTL support\n* AI-based text translation\n* Secure and reviewed implementation\n* High quality source code\n\n... and [more Aimeos features](https://aimeos.org/features)\n\nSupported languages:\n\n\n\u003cp align=\"center\" style=\"display: inline;\"\u003e\n    \u003ca href=\"https://www.transifex.com/aimeos/\"\u003e\u003cimg src=\"https://flagicons.lipis.dev/flags/4x3/us.svg\" title=\"English\" width=\"24\"\u003e\u003c/a\u003e\n    \u003ca href=\"https://www.transifex.com/aimeos/dashboard/all_projects/de/\"\u003e\u003cimg src=\"https://flagicons.lipis.dev/flags/4x3/de.svg\" title=\"German\" width=\"24\"\u003e\u003c/a\u003e\n     \u003ca href=\"https://www.transifex.com/aimeos/dashboard/all_projects/fr/\"\u003e\u003cimg src=\"https://flagicons.lipis.dev/flags/4x3/fr.svg\" title=\"French\" width=\"24\"\u003e\u003c/a\u003e\n     \u003ca href=\"https://www.transifex.com/aimeos/dashboard/all_projects/es/\"\u003e\u003cimg src=\"https://flagicons.lipis.dev/flags/4x3/es.svg\" title=\"Spanish\" width=\"24\"\u003e\u003c/a\u003e\n     \u003ca href=\"https://www.transifex.com/aimeos/dashboard/all_projects/nl/\"\u003e\u003cimg src=\"https://flagicons.lipis.dev/flags/4x3/nl.svg\" title=\"Dutch\" width=\"24\"\u003e\u003c/a\u003e\n     \u003ca href=\"https://www.transifex.com/aimeos/dashboard/all_projects/it/\"\u003e\u003cimg src=\"https://flagicons.lipis.dev/flags/4x3/it.svg\" title=\"Italian\" width=\"24\"\u003e\u003c/a\u003e\n     \u003ca href=\"https://www.transifex.com/aimeos/dashboard/all_projects/pt/\"\u003e\u003cimg src=\"https://flagicons.lipis.dev/flags/4x3/pt.svg\" title=\"Portuguese\" width=\"24\"\u003e\u003c/a\u003e\n     \u003ca href=\"https://www.transifex.com/aimeos/dashboard/all_projects/da/\"\u003e\u003cimg src=\"https://flagicons.lipis.dev/flags/4x3/dk.svg\" title=\"Danish\" width=\"24\"\u003e\u003c/a\u003e\n     \u003ca href=\"https://www.transifex.com/aimeos/dashboard/all_projects/fi/\"\u003e\u003cimg src=\"https://flagicons.lipis.dev/flags/4x3/fi.svg\" title=\"Finnish\" width=\"24\"\u003e\u003c/a\u003e\n     \u003ca href=\"https://www.transifex.com/aimeos/dashboard/all_projects/sv/\"\u003e\u003cimg src=\"https://flagicons.lipis.dev/flags/4x3/sv.svg\" title=\"Swedish\" width=\"24\"\u003e\u003c/a\u003e\n     \u003ca href=\"https://www.transifex.com/aimeos/dashboard/all_projects/no/\"\u003e\u003cimg src=\"https://flagicons.lipis.dev/flags/4x3/no.svg\" title=\"Norwegian\" width=\"24\"\u003e\u003c/a\u003e\n    \u0026nbsp;\u0026nbsp;\u0026nbsp;\n     \u003ca href=\"https://www.transifex.com/aimeos/dashboard/all_projects/pl/\"\u003e\u003cimg src=\"https://flagicons.lipis.dev/flags/4x3/pl.svg\" title=\"Polish\" width=\"24\"\u003e\u003c/a\u003e\n     \u003ca href=\"https://www.transifex.com/aimeos/dashboard/all_projects/hu/\"\u003e\u003cimg src=\"https://flagicons.lipis.dev/flags/4x3/hu.svg\" title=\"Hungarian\" width=\"24\"\u003e\u003c/a\u003e\n     \u003ca href=\"https://www.transifex.com/aimeos/dashboard/all_projects/ru/\"\u003e\u003cimg src=\"https://flagicons.lipis.dev/flags/4x3/ru.svg\" title=\"Russian\" width=\"24\"\u003e\u003c/a\u003e\n     \u003ca href=\"https://www.transifex.com/aimeos/dashboard/all_projects/uk/\"\u003e\u003cimg src=\"https://flagicons.lipis.dev/flags/4x3/ua.svg\" title=\"Ukrainian\" width=\"24\"\u003e\u003c/a\u003e\n     \u003ca href=\"https://www.transifex.com/aimeos/dashboard/all_projects/hr/\"\u003e\u003cimg src=\"https://flagicons.lipis.dev/flags/4x3/hr.svg\" title=\"Croatian\" width=\"24\"\u003e\u003c/a\u003e\n     \u003ca href=\"https://www.transifex.com/aimeos/dashboard/all_projects/sl/\"\u003e\u003cimg src=\"https://flagicons.lipis.dev/flags/4x3/sl.svg\" title=\"Slovenian\" width=\"24\"\u003e\u003c/a\u003e\n     \u003ca href=\"https://www.transifex.com/aimeos/dashboard/all_projects/ro/\"\u003e\u003cimg src=\"https://flagicons.lipis.dev/flags/4x3/ro.svg\" title=\"Romanian\" width=\"24\"\u003e\u003c/a\u003e\n     \u003ca href=\"https://www.transifex.com/aimeos/dashboard/all_projects/cs/\"\u003e\u003cimg src=\"https://flagicons.lipis.dev/flags/4x3/cz.svg\" title=\"Czech\" width=\"24\"\u003e\u003c/a\u003e\n     \u003ca href=\"https://www.transifex.com/aimeos/dashboard/all_projects/sr/\"\u003e\u003cimg src=\"https://flagicons.lipis.dev/flags/4x3/sr.svg\" title=\"Serbian\" width=\"24\"\u003e\u003c/a\u003e\n     \u003ca href=\"https://www.transifex.com/aimeos/dashboard/all_projects/sk/\"\u003e\u003cimg src=\"https://flagicons.lipis.dev/flags/4x3/sk.svg\" title=\"Slovak\" width=\"24\"\u003e\u003c/a\u003e\n     \u003ca href=\"https://www.transifex.com/aimeos/dashboard/all_projects/et/\"\u003e\u003cimg src=\"https://flagicons.lipis.dev/flags/4x3/et.svg\" title=\"Estonian\" width=\"24\"\u003e\u003c/a\u003e\n     \u003ca href=\"https://www.transifex.com/aimeos/dashboard/all_projects/lv/\"\u003e\u003cimg src=\"https://flagicons.lipis.dev/flags/4x3/lv.svg\" title=\"Latvian\" width=\"24\"\u003e\u003c/a\u003e\n    \u0026nbsp;\u0026nbsp;\u0026nbsp;\n     \u003ca href=\"https://www.transifex.com/aimeos/dashboard/all_projects/tr/\"\u003e\u003cimg src=\"https://flagicons.lipis.dev/flags/4x3/tr.svg\" title=\"Turkish\" width=\"24\"\u003e\u003c/a\u003e\n     \u003ca href=\"https://www.transifex.com/aimeos/dashboard/all_projects/ar/\"\u003e\u003cimg src=\"https://flagicons.lipis.dev/flags/4x3/sa.svg\" title=\"Arabic\" width=\"24\"\u003e\u003c/a\u003e\n     \u003ca href=\"https://www.transifex.com/aimeos/dashboard/all_projects/fa/\"\u003e\u003cimg src=\"https://flagicons.lipis.dev/flags/4x3/ir.svg\" title=\"Persian\" width=\"24\"\u003e\u003c/a\u003e\n    \u0026nbsp;\u0026nbsp;\u0026nbsp;\n     \u003ca href=\"https://www.transifex.com/aimeos/dashboard/all_projects/zh/\"\u003e\u003cimg src=\"https://flagicons.lipis.dev/flags/4x3/cn.svg\" title=\"Chinese\" width=\"24\"\u003e\u003c/a\u003e\n     \u003ca href=\"https://www.transifex.com/aimeos/dashboard/all_projects/ja/\"\u003e\u003cimg src=\"https://flagicons.lipis.dev/flags/4x3/jp.svg\" title=\"Japanese\" width=\"24\"\u003e\u003c/a\u003e\n     \u003ca href=\"https://www.transifex.com/aimeos/dashboard/all_projects/id/\"\u003e\u003cimg src=\"https://flagicons.lipis.dev/flags/4x3/id.svg\" title=\"Indonesian\" width=\"24\"\u003e\u003c/a\u003e\n     \u003ca href=\"https://www.transifex.com/aimeos/dashboard/all_projects/vi/\"\u003e\u003cimg src=\"https://flagicons.lipis.dev/flags/4x3/vi.svg\" title=\"Vietnamese\" width=\"24\"\u003e\u003c/a\u003e\n     \u003ca href=\"https://www.transifex.com/aimeos/dashboard/all_projects/my/\"\u003e\u003cimg src=\"https://flagicons.lipis.dev/flags/4x3/my.svg\" title=\"Burmese\" width=\"24\"\u003e\u003c/a\u003e\n     \u003ca href=\"https://www.transifex.com/aimeos/dashboard/all_projects/ko/\"\u003e\u003cimg src=\"https://flagicons.lipis.dev/flags/4x3/kr.svg\" title=\"Korean\" width=\"24\"\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n\nCheck out the demos:\n\n* [Aimeos frontend demo](https://laravel.demo.aimeos.org)\n* [Aimeos admin demo](https://admin.demo.aimeos.org)\n\n## Alternatives\n\n### Integrate into existing applications\n\nYou already have an existing Laravel application and want to add a shop to your\nweb site? Install the Aimeos composer package for Laravel and add e-commerce to\nyour existing application in minutes:\n\n:star:  [Aimeos Laravel package](https://github.com/aimeos/aimeos-laravel)\n\n### Full shop application\n\nIf you want to set up a new application or test Aimeos, we recommend the Aimeos\nshop distribution. It contains everything for a quick start and you will get a\nfully working online shop in less than 5 minutes:\n\n:star:  [Aimeos shop distribution](https://github.com/aimeos/aimeos)\n\n## Table of content\n\n- [Requirements](#requirements)\n- [Installation](#installation)\n- [Frontend](#frontend)\n- [Backend](#backend)\n- [Customize](#customize)\n- [Multi-vendor](#multi-vendor)\n- [License](#license)\n- [Links](#links)\n\n## Requirements\n\nThe Aimeos headless distribution requires:\n- AWS, Google, Azure or Kubernetes cloud, Linux/Unix, WAMP/XAMP or MacOS environment\n- PHP \u003e= 8.2\n- MySQL \u003e= 5.7.8, MariaDB \u003e= 10.2.2, PostgreSQL 9.6+, SQL Server 2019+\n- Web server (Apache, Nginx or integrated PHP web server for testing)\n\nIf required PHP extensions are missing, `composer` will tell you about the missing\ndependencies.\n\nIf you want to upgrade between major versions, please have a look into the\n[upgrade guide](https://aimeos.org/docs/latest/laravel/setup/#upgrade)!\n\n## Installation\n\nTo install the Aimeos shop application, you need [composer 2.2+](https://getcomposer.org).\nOn the CLI, execute this command for a complete installation including a working setup:\n\n```\nwget https://getcomposer.org/download/latest-stable/composer.phar -O composer\nphp composer create-project aimeos/aimeos-headless headless\n```\n\nYou will be asked for the parameters of your database and mail server as well as an\ne-mail and password used for creating the administration account.\n\nIn a local environment, you can use the integrated PHP web server to test your new Aimeos\ninstallation. Simply execute the following command to start the web server:\n\n```\ncd headless\nphp artisan serve\n```\n\n**Note:** In an hosting environment, the document root of your virtual host must point to\nthe **/.../headless/public/** directory and you have to change the `APP_URL` setting in your `.env`\nfile to your domain without port, e.g.:\n\n```\nAPP_URL=http://myhostingdomain.com\n```\n\n## JSON REST API\n\nAfter the installation, you can test the Aimeos JSON REST API by calling the URL of your\nVHost in your browser. If you use the integrated PHP web server, you should browse\nthis URL: [http://127.0.0.1:8000/jsonapi](http://127.0.0.1:8000/jsonapi)\n\nLearn how to use the [JSON REST API](https://aimeos.org/docs/latest/frontend/jsonapi/)\n\n### Authenticate\n\nTo authenticate using e-mail and password, send a POST request:\n\n```bash\ncurl -X POST \"http://127.0.0.1:8000/api/login?email=me@localhost\u0026password=test\"\n```\n\nIf the authentication was successful, the API will return with a response like this:\n\n```json\n{\"access_token\":\"eyJ0eXAiOiJKV...\",\"token_type\":\"bearer\",\"expires_in\":3600}\n```\n\nUse this access token in all further requests as HTTP header:\n\n```bash\ncurl -X POST \"http://127.0.0.1:8000/api/me\" -H \"Authorization: Bearer eyJ0eXAiOiJKV...\"\n```\n\n## Backend\n\nThe Aimeos administration interface will be available at `/admin` in your VHost. When using\nthe integrated PHP web server, call this URL: [http://127.0.0.1:8000/admin](http://127.0.0.1:8000/admin)\n\n[![Aimeos admin backend](https://aimeos.org/fileadmin/aimeos.org/images/aimeos-backend.png?2021.04)](http://admin.demo.aimeos.org/)\n\n## Cloud filesystems\n\nTo use cloud storage like AWS S3 compatible object storages, adapt the `resource/fs` sections\nin the `./config/shop.php` file and configure the filesystem like this:\n\n```\ncomposer req ai-filesystem league/flysystem-aws-s3-v3\n```\n\n```php\n'fs' =\u003e [\n\t'adapter' =\u003e 'FlyAwsS3',\n\t'credentials' =\u003e [\n\t\t'key' =\u003e 'your-key',\n\t\t'secret' =\u003e 'your-secret',\n\t],\n\t'region' =\u003e 'your-region',\n\t'version' =\u003e 'latest|api-version',\n\t'bucket' =\u003e 'your-bucket-name',\n\t'prefix' =\u003e 'your-prefix', // optional\n    'baseurl' =\u003e 's3-domain-and-path'\n],\n```\n\nFor Azure Blob storage use:\n\n```\ncomposer req ai-filesystem league/flysystem-azure-blob-storage\n```\n\n```php\n'fs' =\u003e [\n\t'adapter' =\u003e 'FlyAzure',\n\t'endpoint' =\u003e 'DefaultEndpointsProtocol=https;AccountName=your-account;AccountKey=your-api-key',\n\t'container' =\u003e 'your-container',\n\t'prefix' =\u003e 'your-prefix', // optional\n    'baseurl' =\u003e 'azure-domain-and-path'\n],\n```\n\nAnd for Google Cloud storage:\n\n```\ncomposer req ai-filesystem league/flysystem-google-cloud-storage\n```\n\n```php\n'fs' =\u003e [\n\t'adapter' =\u003e 'FlyGoogleCloud',\n\t'keyFile' =\u003e json_decode(file_get_contents('/path/to/keyfile.json'), true), // alternative\n\t'keyFilePath' =\u003e '/path/to/keyfile.json', // alternative\n\t'projectId' =\u003e 'myProject', // alternative\n\t'prefix' =\u003e 'your-prefix' // optional\n    'baseurl' =\u003e 'gcloud-domain-and-path'\n],\n```\n\n## Customize\n\nLaravel and the Aimeos headless ecommerce distribution are extremely flexible and highly customizable.\nA lot of documentation for the [Laravel framework](https://laravel.com) and the\n[Aimeos ecommerce framework](https://aimeos.org/docs/latest/) exists. If you have questions\nabout Aimeos, don't hesitate to ask in our [Aimeos forum](https://aimeos.org/help/).\n\n## License\n\nThe Aimeos shop system is licensed under the terms of the MIT and LGPLv3 license and\nis available for free.\n\n## Links\n\n* [Web site](https://aimeos.org/Laravel)\n* [Documentation](https://aimeos.org/docs/latest/)\n* [Forum](https://aimeos.org/help/)\n* [Issue tracker](https://github.com/aimeos/aimeos-headless/issues)\n* [Composer packages](https://packagist.org/packages/aimeos/aimeos-headless)\n* [Source code](https://github.com/aimeos/aimeos-headless)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faimeos%2Faimeos-headless","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Faimeos%2Faimeos-headless","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faimeos%2Faimeos-headless/lists"}