Server : Apache System : Linux server2.corals.io 4.18.0-348.2.1.el8_5.x86_64 #1 SMP Mon Nov 15 09:17:08 EST 2021 x86_64 User : corals ( 1002) PHP Version : 7.4.33 Disable Function : exec,passthru,shell_exec,system Directory :  /home/corals/old/app/code/Soon/Core/

Upload File : current_dir [ Writeable ] document_root [ Writeable ]

## What is Soon_Core?

Soon_Core is a module that must be installed with Jade for Magento 2.
Please read https://confluence.kaliop.net/display/SDT/Technical+onboarding+Magento+2 if you want to use Jade for Magento 2.

## What comes with Soon_Core?

- A ready-to-use theme for your project that inherits from Soon_JadeFrontend (https://bitbucket.org/agencesoon/soon_jade_frontend_m2)
- A preconfigured SCSS build system
- An optimized Magento configuration fitting to our most common needs
- French locale
- Taxes configuration for Europe
- Clean customer groups
- Clean CMS with common CMS pages
- Some basic email templates

## About the (S)CSS

### Compiling SCSS

Jade for Magento 2 uses the `snowdog/frontools` module: https://github.com/SnowdogApps/magento2-frontools

Its `themes.json` file is in `(install_dir)/dev/tools/frontools/config/themes.json`.

Please read `snowdog/frontools` documentation in order to have tips about useful watch, build, styles processing, etc Gulp commands.

## Using the store installer

The store installer is a neat feature allowing you to create websites, stores (store groups) and store views (stores) easily with a YAML file.

1. Copy / paste the `Setup/config/store.yml.sample` of Soon_Core to your module's directory. For example: `app/code/Namespace/Module/Setup/config/store.yml`
2. Update your `store.yml` file in order to fit your need
3. In some of your module's install script, just inject `\Soon\Core\Setup\StoreInstaller` and call its `install` method and passing your `store.yml` relative path as argument.

Example: 
```
class \Namespace\Module\Setup\StoreInstaller
{
    // store.yaml file is located in app/code/Namespace/Setup/config/store.yaml
    const STORE_CONFIG_YAML_PATH = 'Namespace_Module::Setup/config/store.yaml';

    public function __construct(
        \Soon\Core\Setup\StoreInstaller $storeInstaller
    )
    {
        $this->storeInstaller = $storeInstaller;
    }

    public function install(): void
    {
        $this->storeInstaller->install(self::STORE_CONFIG_YAML_PATH);
    }
}
```