Installation & Setup

This guide walks you through installing yStore into an existing Craft CMS 5 project.

Prerequisites

Before you begin, make sure you have:

• Craft CMS 5.x installed and running
• PHP 8.2+ with the extensions Craft requires (mbstring, intl, pdo, pdo_mysql or pdo_pgsql)
• Composer 2.x available on your machine or server
• Valid yStore license credentials — your Composer username and password from yui.sk
• Database user with CREATE TABLE, ALTER TABLE, and DROP TABLE privileges (required for migrations)

Step 1 — Add the Composer repository

yStore is distributed via a private Composer repository. Add it to your project's composer.json:

composer config repositories.ystore composer https://composer.yui.sk

This adds the repository entry automatically. You can verify it was added by checking the repositories key in your composer.json.

Step 2 — Configure authentication

Composer needs your yStore license credentials to access the private repository. Add them to your project's auth.json file (create it in your project root if it does not exist):

{
    "http-basic": {
        "composer.yui.sk": {
            "username": "your-license-username",
            "password": "your-license-password"
        }
    }
}

Do not commit auth.json

auth.json contains your private license credentials. Add it to .gitignore immediately:

echo "auth.json" >> .gitignore

If you accidentally commit it, rotate your credentials at yui.sk right away.

Step 3 — Require the package

Install yStore via Composer:

composer require yui/craft-plugin

Composer will resolve dependencies and download the plugin into vendor/.

Step 4 — Install the plugin in Craft

Run Craft's plugin install command:

php craft plugin/install ystore

This registers the plugin with Craft and runs all yStore database migrations automatically. You should see a confirmation message when installation completes.

Step 5 — Validate the installation

Run the yStore validate command to confirm that all required tables, queue jobs, and configuration are in place:

php craft ystore/validate

The validator checks:

• All required database tables exist
• Pending migrations have been applied
• Plugin configuration is readable
• Required Craft services (queue, cache, mailer) are accessible

If the validator reports any issues, see the Troubleshooting guide.

Optional: Seed demo data

If you want to explore yStore with sample products, orders, and customers before building your real catalog, you can seed demo data (requires the Seeder utility plugin):

php craft ystore/seed

Seeder plugin

The Seeder plugin must be installed separately. See Plugins → Utilities for installation instructions.

What's next?

• Overview — Understand yStore's architecture and editions
• Backend Overview — A walkthrough of the yStore CP sections
• Core Features — Full breakdown of what yStore includes out of the box