🌐 Language: 🇻🇳 Tiếng Việt · 🇬🇧 English (current) · 🇯🇵 日本語

S-Cart

composer create-project gp247/s-cart my-shop

Free, open-source e-commerce software built on GP247 and Laravel

Packagist Downloads Latest Stable Version License Ask DeepWiki

🏠 Homepage · 🚀 Demo · 📚 Documentation · 🤖 AI agent skills · 💬 Facebook group

S-Cart storefront S-Cart admin dashboard

Introduction

S-Cart is free, open-source online-store software (MIT license) for store owners, businesses and developers. Once installed, you have a complete online shop (products, cart, orders, customers, content pages) plus an admin panel. All of S-Cart is free to use, modify and integrate into your own system; Pro plugins are optional add-ons for when a shop needs to grow, such as several stores or a marketplace with many sellers.

S-Cart is built on four principles:

Principle What you get
🎯 Solves the seller's real work SEO, backup & restore, role-based permissions and reports are built in from the first install, no plugin needed. Install and update with a few commands.
🌍 Runs in many environments From shared hosting without cron to VPS and Docker.
🔐 Secure One layer of permissions and activity logs shared by the admin panel, the API and AI agents; passwords and third-party keys are stored encrypted.
🧩 Easy to customize Extend with plugins and templates, and override screens or logic without touching the original code — updates keep your changes.

After reading this page you will be able to install S-Cart on your machine or server, and know how to update and customize it.

S-Cart 3.x tech stack: PHP ≥ 8.3 · Laravel 13 · GP247 · Tailwind CSS 3 · MySQL / MariaDB

S-Cart and GP247

S-Cart = GP247/core + GP247/front + GP247/shop + GP247/mcp

GP247 is an open-source ecosystem on Laravel for building business web applications. S-Cart is the e-commerce product built on it, made of four packages:

Package Provides
gp247/core Core: admin panel, permissions, configuration, plugins & templates
gp247/front Storefront, content (CMS)
gp247/shop Products, cart, orders, customers
gp247/mcp MCP server for AI agents

You only install S-Cart — all four packages come with it; there is no separate GP247 install.

✨ What's in S-Cart

Area Features
🛍️ Commerce Products, cart, orders, customers
🌏 International Multi-language, multi-currency
📰 Content (CMS) Categories, content pages; news (free News plugin)
💳 Payment & shipping Payment plugins, shipping methods, discount codes, tax calculation
🔐 Admin & security Role-based permissions (admin, manager, marketing…), activity log, CAPTCHA
📊 Business tools Order processing, customer management, analytics & reports
🤖 AI-ready (MCP server) Built-in MCP server (off until you turn it on): connect AI agents (Claude, Cursor, VS Code…) to your shop via the Model Context Protocol and just ask — "how much did we sell this week?", "which products are low on stock?", "is order OR-1024 paid?". The agent acts as one admin account with the same permissions, token-secured, customer data masked, every call logged
🧩 Extensibility HMVC plugins, online plugin/template marketplace, secured API for mobile apps
⭐ Pro plugins Multi-vendor (marketplace with many sellers) · Multi-store (several stores) · InOut (purchases, returns, cash flow & debts)

🧰 Requirements

Component Requirement
PHP 8.3 or newer
Composer Version 2.x
Database MySQL or MariaDB — create an empty database first
Writable folders storage · bootstrap/cache · app/GP247 · public/GP247 · public/vendor · resources/views/vendor · vendor

💡 With Docker you don't need PHP, Composer or MySQL on your machine — see Option 3.

🚀 Installation

📘 Full installation guide — choosing a package set (S-Cart, GP247 CMS, core only), hosting without a command line, adding front/shop to an existing site, troubleshooting: Installing GP247 and S-Cart.

Pick one of three options:

Option Best when
1. Composer ⭐ Installing on hosting, a VPS, or a machine with Laragon/XAMPP — recommended
2. Git clone You want the latest source from GitHub to develop or contribute
3. Docker You don't want to install PHP/MySQL on your machine
  1. Open a Terminal (on Windows: "Command Prompt" or the Laragon terminal) and check which PHP Composer runs on:

    composer diagnose
    

    The PHP version line must be 8.3 or newer.

    ⚠️ On a PHP older than 8.3, Composer does not fail — it silently installs a very old S-Cart 1.x. Switch Composer to PHP 8.3 or newer before step 2.

  2. Create the project (replace my-shop with the folder name you want):

    composer create-project gp247/s-cart my-shop
    cd my-shop
    
  3. Open the .env file in the project folder and set the database section to match the database you created:

    DB_HOST=127.0.0.1
    DB_PORT=3306
    DB_DATABASE=your_database
    DB_USERNAME=your_username
    DB_PASSWORD=your_password
    

    The default DB_HOST=mysql-local is for Docker only — for a direct install change it to 127.0.0.1.

  4. Install S-Cart:

    php artisan gp247:install
    

    The command asks for confirmation — type yes. When the install finishes, the last block on the screen shows the admin path, the user name admin and a random password.

    ⚠️ The password is shown only once, right after a successful install — it is not stored anywhere and never printed again. Save it in a password manager before you close the Terminal.

  5. (Optional) Add sample data to try it out:

    php artisan gp247:shop-sample
    
  6. Open your browser:

    Page Address Login
    Storefront http://your-domain —
    Admin http://your-domain/gp247_admin admin / the password printed in step 4

    🔑 After signing in, change the account email to a real one (Setting account at the top) so Forgot password works.

Option 2 — Git clone

git clone https://github.com/gp247net/s-cart.git
cd s-cart
cp .env.example .env
composer install

Then continue with steps 3 → 6 of Option 1 (edit .env, run gp247:install, open the browser).

Option 3 — Docker

There are two separate compose files — always use the right one for the environment:

File Environment
docker-compose.yml dev — your local machine
docker-compose.prod.yml prod — a real server

Local machine (dev):

git clone https://github.com/gp247net/s-cart.git
cd s-cart
cp .env.example .env
docker compose up -d --build
docker compose exec app php artisan key:generate
docker compose exec app php artisan gp247:install
docker compose exec app php artisan gp247:shop-sample   # optional

Open the site at http://localhost:8000.

Real server (prod):

git clone https://github.com/gp247net/s-cart.git
cd s-cart
cp .env.example .env
# Edit .env: APP_ENV=production, APP_DEBUG=false, DB_*, SC_DOCKER_WWWUSER/SC_DOCKER_WWWGROUP — see DOCKER.md
docker compose -f docker-compose.prod.yml up -d --build
docker compose -f docker-compose.prod.yml exec app php artisan key:generate
docker compose -f docker-compose.prod.yml exec app php artisan gp247:install
docker compose -f docker-compose.prod.yml run --rm node   # build CSS/JS

⚠️ On prod always add -f docker-compose.prod.yml. Forgetting it runs the dev config by mistake (debug on, running as root, Xdebug installed…).

📘 Step-by-step guide and Docker troubleshooting: DOCKER.md.

🔄 Updating

📘 Full guide: Updating GP247 and S-Cart · site still on 2.x: Upgrading to the 3.x line.

  1. Back up the database and the app/GP247, public/GP247 folders before updating.

  2. Download the new code:

    composer update gp247/core gp247/front gp247/shop gp247/mcp
    

    Site installed before S-Cart 3.5 (no MCP server yet): run composer require gp247/mcp -W once.

  3. Apply the changes to the site (safe: deletes no data, does not overwrite translations or templates you edited):

    php artisan gp247:update
    
  4. Check the result:

    php artisan gp247:info
    

⚠️ Running composer update alone is not enough — always run step 3 too.

Advanced options (overwrite translations with --overwrite-lang, refresh assets/views with --publish=…) can overwrite your customizations — read the Updating GP247 and S-Cart — Advanced options carefully before using them.

🎨 Customization & extension

You want to… How
Create a new plugin php artisan gp247:make-plugin --name=PluginName
Create a new template php artisan gp247:make-template --name=TemplateName
Package a zip for distribution Add --download=1 to either command above
Edit one screen of the default template php artisan gp247:template-publish GP247Front --file=screen/home.blade.php, then edit the file in app/GP247/Templates/GP247Front/
Customize the admin UI php artisan vendor:publish --tag=gp247:core-view (core) · --tag=gp247:front-admin (front) · --tag=gp247:shop-view-admin (shop)
Change the file-upload config (lfm) php artisan vendor:publish --tag=config-lfm
Override a gp247_* helper List the function names in config/gp247_functions_except.php, then write the new functions in app/GP247/Helpers/*.php
Override a controller See below
Add routes to the admin area Use the GP247_ADMIN_PREFIX and GP247_ADMIN_MIDDLEWARE constants — see the core routes.php

💡 The default GP247Front template is loaded directly from the package, so files you have not published pick up new versions automatically when you update. Publish only the files you need to edit.

Override a controller

Works for every controller (API included) in GP247/Core, GP247/Front, GP247/Shop:

  1. Create a file with the same sub-path and name under app/GP247/{Core|Front|Shop}/....

  2. Make the new class extends the original controller in vendor/gp247/....

  3. Prepend App\ to the original namespace, keeping the rest as-is:

    Original namespace New namespace
    GP247\Core\Controllers App\GP247\Core\Controllers
    GP247\Core\Api\Controllers App\GP247\Core\Api\Controllers
    GP247\Front\... / GP247\Shop\... App\GP247\Front\... / App\GP247\Shop\...

📘 Detailed docs: Create a plugin · Create a template · Full CLI reference

📂 Folder structure

(+) = folder created and managed by GP247.

my-shop/
├── app/GP247/
│   ├── Core(+)        ← Core controller overrides
│   ├── Front(+)       ← Front controller overrides
│   ├── Shop(+)        ← Shop controller overrides
│   ├── Helpers(+)     ← *.php files here are auto-loaded
│   ├── Plugins(+)     ← plugins (gp247:make-plugin)
│   └── Templates(+)   ← templates (gp247:make-template) + template files published for editing
├── public/GP247/
│   ├── Core(+)        ← admin CSS/JS
│   ├── Plugins(+)
│   └── Templates(+)
├── resources/views/vendor/
│   ├── gp247-admin(+)        ← published Core admin views
│   ├── gp247-front-admin(+)  ← published Front admin views
│   └── gp247-shop-admin(+)   ← published Shop admin views
└── vendor/gp247/
    ├── core           ← core: admin, permissions, configuration
    ├── front          ← storefront, CMS
    ├── shop           ← products, cart, orders
    └── mcp            ← MCP server for AI agents

🔧 Common environment variables

Set these in the .env file:

Variable Default Meaning
GP247_ADMIN_PREFIX gp247_admin Admin path, e.g. your-domain.com/gp247_admin
GP247_API_MODE 1 Enable (1) / disable (0) the API
GP247_DB_PREFIX gp247_ Table name prefix — ⚠️ cannot be changed after install
GP247_ADMIN_LOG 1 Log admin access
GP247_SEO_LANG 0 Add the language code to storefront URLs (/en/..., /vi/...)
GP247_ENCRYPTION_KEY (empty) Dedicated key for encrypting SMTP passwords, licenses… — see the notes in .env.example