Skip to main content
Version: 1.0.0

Introduction

This installation guide provides step-by-step instructions for installing the YSCP (YUI Shop Craft Plugin) on your server. The guide assumes you have a basic understanding of programming concepts, specifically PHP and CraftCms. By following these instructions, you will be able to successfully install YSCP and start building your online store.

Prerequisites​

Before proceeding with the installation, please ensure that your server meets the following prerequisites:

  • PHP 8.1 or later
  • MySQL 8.0 or later
  • Apache or Nginx web server
  • Composer 2
  • CraftCms 5 or later

Included Packages​

When you install the YSCP, several essential packages are included by default. This means there is no need to install them separately. The included packages are:

  • CKEditor: A powerful WYSIWYG editor for content creation.
  • Minify: A tool for minifying CSS and JS files to improve site performance.
  • CronExpression: Parses cron expressions for scheduling tasks.
  • Emogrifier: Inlines CSS for HTML emails.
  • Google ReCaptcha: Protects your site from spam and abuse.
  • PdfInvoice: Generates PDF invoices

These packages are integrated with the Craft plugin to streamline the installation and setup process.

Step 1: Extending the composer.json​

To make possible to install YUI plugins from composer, first add the https://packages.yui.sk/ repository to your composer.json:

"repositories": [
    {
      "type": "composer",
      "url": "https://packages.yui.sk/"
    }
  ]

Step 2. Creating auth.json​

Create a file named auth.json in the same directory as your composer.json. This file should contain the credentials provided by the administrator. These credentials are required to install and update our Craft CMS plugins via Composer.

{
  "http-basic": {
    "packages.yui.sk": {
      "username": "user_xy",
      "password": "password"
    },
    "repo.yui.sk": {
      "username": "user_xy",
      "password": "password"
    }
  }
}

Step 3: Install using Composer​

The first step in the installation process is to install the YSCP package. You can download the package from the website or use Composer to install it (We recommend to use Composer).

    composer require yui/craft-plugin
warning

To complete the installation, you will need to provide auth credentials.

Step 4: Validating the installation​

When its complete, you can run the following command to ensure all Database Tables are up-to date.

php craft yui/plugin/validate
tip

To debug the validation, you can use the verbose parameter, example: php craft yui/plugin/validate 1

Conclusion​

Congratulations! You have successfully installed YSCP on your server. You can now start building your online store and customizing it to fit your needs.

Please refer to the documentation for more information on how to configure and use our plugin.