Documentation

Installation & Setup

Prerequisites and step-by-step installation guide for Cartxis

Last updated: Feb 09, 2026

Installation & Setup

Prerequisites

RequirementMinimum Version
PHP8.2+
Node.js18+
Composer2.x
MySQL / MariaDB8.0+ / 10.6+
Redis (optional)6+

Installation Steps

# 1. Clone the repository
git clone <repository-url> cartxis
cd cartxis

# 2. Install PHP dependencies
composer install

# 3. Install Node.js dependencies
npm install

# 4. Configure environment
cp .env.example .env
php artisan key:generate

# 5. Configure your database in .env
#    DB_CONNECTION=mysql
#    DB_HOST=127.0.0.1
#    DB_PORT=3306
#    DB_DATABASE=cartxis
#    DB_USERNAME=root
#    DB_PASSWORD=

# 6. Run migrations and seed data
php artisan migrate --seed

# 7. Create storage symlink
php artisan storage:link

# 8. Build frontend assets
npm run build        # Production build
npm run dev          # Development with HMR

# 9. Start the development server
php artisan serve

Post-Installation

  • Access the admin panel at http://your-domain/admin
  • Log in with the default admin credentials created during seeding
  • Navigate to Settings → General Settings to configure your site name, branding, and contact details
  • Navigate to Settings → Store Configuration to set up business information and store policies
  • Configure at least one Payment Method and one Shipping Method before accepting orders
PreviousIntroductionNextGetting Started