@snowdog/create-alpaca-theme v1.0.1

Create Alpaca Theme

Quickly create Magento 2 Child Theme based on Snowdog Alpaca Theme.

Requirements

• Working and valid Magento 2.4 instance.
• Node >= 16.

Quick Overview

• Run from Magento project root directory:

  npx @snowdog/create-alpaca-theme

• Select installation options.

After installation is completed:

• Go to Admin Panel -> Content -> Design -> Configuration and choose your theme.
• Run yarn dev in app/design/frontend/VENDOR_NAME/CHILD_THEME_NAME/Snowdog_Components directory to see components in Fractal environment.

What it does?

• Installs following packages:
  • snowdog/frontools
  • snowdog/module-alpaca-packages containing:
    • snowdog/theme-frontend-alpaca
    • magepal/magento2-gmailsmtpapp
    • magepal/magento2-googletagmanager
    • mailchimp/mc-magento2
    • smile/elasticsuite
    • snowdog/module-alpaca-general
    • snowdog/module-bullet-points
    • snowdog/module-csp
    • snowdog/module-category-attributes
    • snowdog/module-menu
    • snowdog/module-product-attribute-description
    • snowdog/module-shipping-latency
    • snowdog/module-wishlist-unlocker
    • webshopapps/module-matrixrate
• Creates Alpaca Child Theme in app/design/frontend/VENDOR_NAME/CHILD_THEME_NAME including everything you need to start working with Alpaca:
  • Essential configuration files
  • Styles inheritance setup
  • Custom variables file in Snowdog_Components/components/Atoms/variables/ directory
  • Example of how to change Sass variable value
  • Example of how to extend component styles (If selected during installation)
• Adds frontools configuration files in dev/tools/frontools/config directory.
• Updates database with essential Alpaca Tables (If selected during installation).
• Adds placeholder images.
• Upgrades Magento instance, compiles styles, JS files and SVGs.

User guide

• Alpaca Theme Docs - Learn how to utilize Alpaca Theme.

Useful Links

• Alpaca Theme
• Snowdog Frontools
• Fractal guide
• Alpaca Packages
• Alpaca Components preview

Testing and local development

• Clone this repository
• Change name of package in package.json to create-alpaca-theme
• Install package globally: npm install -g
• Link command running npm link
• Run npx create-alpaca-theme from Magento project root directory

Troubleshooting

• If you have problems with global npm persmission, check npm docs: Resolving eaccess permissions error when installing package globally
• When running Warden or other dockerized Magento instance, make sure you run npx @snowdog/create-alpaca-theme from proper container.

2022 Snowdog