🌐 Language: 🇻🇳 Tiếng Việt · 🇬🇧 English (current)

composer create-project gp247/s-cart my-shop "^3.0"

Introduction

S-Cart is free, open-source online-store software for businesses, individual sellers, developers and students. You get a complete online shop (products, cart, orders, customers, news) plus an admin panel, and you can extend it with plugins and templates. 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 4 · MySQL / MariaDB

✨ What's in S-Cart

🧰 Requirements

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

🚀 Installation

Pick one of three options:

Option 1 — Composer (recommended)

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 an older PHP, Composer does not fail — it silently installs a very old S-Cart 1.x. Always keep "^3.0" in the step 2 command so Composer fails loudly instead of installing the wrong version.

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

   composer create-project gp247/s-cart my-shop "^3.0"
   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 it finishes, the screen shows the admin path and login.

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 / admin

   🔑 Change the admin password right after your first login.

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:

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

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
   

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 GP247 update guide carefully before using them.

🎨 Customization & extension

💡 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

🔧 Common environment variables

Set these in the .env file:

❓ Q&A

Q1: Composer finished but then reported Access denied for user 'root' — what happened?

→ Composer ran on a PHP older than 8.3 and installed S-Cart 1.x by mistake. Delete the new folder, switch Composer to PHP 8.3+ (check with composer diagnose), then install again with "^3.0".

Q2: Where is the admin panel and how do I log in?

→ http://your-domain/gp247_admin, user admin / password admin. Change the password right away.

Q3: How do I see which version I'm running?

→ Run php artisan gp247:info.

Q4: The site is broken or won't install — what should I check first?

→ Run php artisan gp247:doctor — it checks the environment (PHP, folder write permissions, configuration…) and points out what to fix. Also check the writable folders listed under Requirements.

Q5: Will updating lose my data or my changes?

→ php artisan gp247:update deletes no data and keeps the translations and templates you edited. Only the --overwrite-lang and --publish=… options can overwrite them — back up before using them.

Q6: I edited the default template — will an update wipe my changes?

→ No, as long as you publish only the files you edit with gp247:template-publish GP247Front --file=.... Your edited files are kept; the rest pick up new versions from the package.

Q7: How do I change the admin path?

→ Set GP247_ADMIN_PREFIX in .env (e.g. backoffice). Don't use the name of an existing folder in public/ (such as vendor or GP247), otherwise the page returns a 403 error.

Q8: Can I change the table prefix (GP247_DB_PREFIX) after installing?

→ No. Choose it before running gp247:install.

Q9: I don't use a mobile app — should I disable the API?

→ You can. Set GP247_API_MODE=0 in .env.

Q10: Where can I ask for more help?

→ Read the GP247 documentation, ask DeepWiki, or post in the S-Cart Facebook group.

_{📅 Last updated: 2026-09-29 · ✍️ Author: GP247}