|
1 | | -# kustom-m2-checkout |
2 | | -# kustom-m2-checkout |
| 1 | +# Kustom M2 Checkout |
| 2 | + |
| 3 | +## Overview |
| 4 | + |
| 5 | +`kustom-m2-checkout` is a metapackage for Magento 2 that orchestrates a comprehensive checkout solution for e-commerce platforms. It aggregates multiple specialized modules designed to enhance and streamline the checkout experience, payments processing, and order management within Magento 2. |
| 6 | + |
| 7 | +## Purpose |
| 8 | + |
| 9 | +This metapackage serves as a unified checkout ecosystem for Magento 2, combining the following key functionalities: |
| 10 | + |
| 11 | +- **Payment Processing**: Comprehensive payment methods support including Klarna and Klarna Checkout (KCO) |
| 12 | +- **Order Management**: Advanced order line management and order status management |
| 13 | +- **GraphQL Support**: GraphQL API endpoints for modern headless commerce implementations |
| 14 | +- **Logging & Debugging**: Centralized logging for monitoring and troubleshooting |
| 15 | +- **Admin Settings**: Customizable admin configuration panel for checkout features |
| 16 | +- **API Integrations**: Plugin API support and Klarna API integrations |
| 17 | +- **Sign-In Workflows**: Kustom Sign In With Klarna (SIWK) functionality |
| 18 | +- **Knowledge Base System**: Kustom Service Support (KSS) module |
| 19 | +- **Core Infrastructure**: Base modules for module support and interoperability |
| 20 | + |
| 21 | +## Included Modules |
| 22 | + |
| 23 | +The metapackage includes the following dependencies: |
| 24 | + |
| 25 | +- `vaimo/kustom-module-support` - Core support functionality |
| 26 | +- `vaimo/kustom-module-siwk` - Sign In With Klarna |
| 27 | +- `vaimo/kustom-module-plugins-api` - Plugins API framework |
| 28 | +- `vaimo/kustom-module-orderlines` - Order line management |
| 29 | +- `vaimo/kustom-module-osm` - Order status management |
| 30 | +- `vaimo/kustom-module-kss` - Kustom Service Support |
| 31 | +- `vaimo/kustom-module-payments-graph-ql` - GraphQL payment APIs |
| 32 | +- `vaimo/kustom-module-payments` - Payment processing |
| 33 | +- `vaimo/kustom-module-klarna-api` - Klarna API integration |
| 34 | +- `vaimo/kustom-module-kco` - Klarna Checkout integration |
| 35 | +- `vaimo/kustom-module-base` - Base module utilities |
| 36 | +- `vaimo/kustom-module-backend` - Backend services |
| 37 | +- `vaimo/kustom-module-admin-settings` - Admin configuration |
| 38 | +- `vaimo/kustom-module-logger` - Logging utilities |
| 39 | + |
| 40 | +## Installation |
| 41 | + |
| 42 | +This is a metapackage and should be installed via Composer as part of your Magento 2 project: |
| 43 | + |
| 44 | +```bash |
| 45 | +composer require vaimo/kustom-m2-checkout |
| 46 | +``` |
| 47 | + |
| 48 | +## Requirements |
| 49 | + |
| 50 | +- Magento 2.x |
| 51 | +- Composer |
| 52 | +- Access to Magento Composer repository and Vaimo GitHub repositories |
0 commit comments