Development Workflow
Initial setup, daily development, adding packages, payment gateways, themes, and code quality
Last updated: Feb 09, 2026
Development Workflow
Initial Setup
git clone <repo-url> cartxis
cd cartxis
composer setup
# Configure .env (APP_URL, DB credentials, payment gateway keys)
Daily Development
composer dev
# → http://localhost:8000 (Laravel)
# → http://localhost:5173 (Vite HMR)
# → Queue worker active
Adding a New Package
- Create directory:
packages/Cartxis/NewPackage/ - Add ServiceProvider in
Providers/ - Add namespace to
composer.jsonPSR-4 autoload - Register provider in
bootstrap/providers.php - Run
composer dump-autoload - Add routes, models, controllers, migrations as needed
Adding a Payment Gateway
- Copy template from
extension/templates/payment-gateway/ - Implement
PaymentGatewayInterface - Create
extension.jsonmanifest - Register gateway in ServiceProvider with
PaymentGatewayManager - Seed payment method record
- Add admin config routes for managing API keys
- Install and activate via CLI:
php artisan cartxis:extensions:install {code} && php artisan cartxis:extensions:activate {code}
Creating a Theme
- Create
themes/{slug}/withtheme.json - Add
resources/views/layouts/ThemeLayout.vue - Override pages in
resources/views/pages/ - Add theme-specific components in
resources/views/components/ - Activate in Admin → Settings → Themes
Code Quality
# PHP formatting
./vendor/bin/pint
# JS/Vue linting + formatting
npm run lint
npm run format
# Type checking
npx vue-tsc --noEmit
# Tests
composer test
Namespace Reference
| Namespace | Path |
|---|---|
App\ | app/ |
Cartxis\Core\ | packages/Cartxis/Core/ |
Cartxis\Admin\ | packages/Cartxis/Admin/ |
Cartxis\Product\ | packages/Cartxis/Product/ |
Cartxis\Cart\ | packages/Cartxis/Cart/ |
Cartxis\Shop\ | packages/Cartxis/Shop/ |
Cartxis\Settings\ | packages/Cartxis/Settings/ |
Cartxis\Sales\ | packages/Cartxis/Sales/src/ |
Cartxis\Customer\ | packages/Cartxis/Customer/src/ |
Cartxis\CMS\ | packages/Cartxis/CMS/src/ |
Cartxis\System\ | packages/Cartxis/System/src/ |
Cartxis\Reports\ | packages/Cartxis/Reports/src/ |
Cartxis\Marketing\ | packages/Cartxis/Marketing/src/ |
Cartxis\API\ | packages/Cartxis/API/ |
Cartxis\Setup\ | packages/Cartxis/Setup/src/ |
Cartxis\Stripe\ | packages/Cartxis/Stripe/src/ |
Cartxis\Razorpay\ | packages/Cartxis/Razorpay/src/ |
Cartxis\PayPal\ | packages/Cartxis/PayPal/src/ |
Cartxis\PayUMoney\ | packages/Cartxis/PayUMoney/src/ |
Cartxis\PhonePe\ | packages/Cartxis/PhonePe/src/ |
Tests\ | tests/ |
