Skip to content
This repository has been archived by the owner on Apr 26, 2023. It is now read-only.

Commit

Permalink
wip
Browse files Browse the repository at this point in the history
  • Loading branch information
ofrankowska committed Mar 29, 2022
1 parent 9f0dbd4 commit 58bba83
Showing 1 changed file with 46 additions and 39 deletions.
85 changes: 46 additions & 39 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,30 @@
# Alpaca - components & theme for Magento 2.4
div align="center">
<img src="./web/images/icons/logo.svg" alt="Alpaca Logo" width="600"/>

[![Latest Stable Version](http://poser.pugx.org/snowdog/theme-frontend-alpaca/v)](https://packagist.org/packages/snowdog/theme-frontend-alpaca) [![Total Downloads](http://poser.pugx.org/snowdog/theme-frontend-alpaca/downloads)](https://packagist.org/packages/snowdog/theme-frontend-alpaca)<br>
📚 [Docs](./docs) | 📝 [Changelog](./CHANGELOG.md)<br>

<br>

[Magento OS Demo](https://alpaca-community.snowdog.dev/) | [Magento Commerce Demo](https://alpaca-commerce.snowdog.dev/) | [Components Preview](https://magento2-alpaca-theme-git-master-snowdog1.vercel.app/)<br>
</div>

# Magento 2 Theme Frontend Alpaca

📝 Component-based
📚 Feature-rich
🎨 Themable
♿️ Accessible
💅 Polished

## Migration guide for Alpaca theme >= 2.26.0
`2.26.0` version includes a lot of changes and has different files structure, please go to [Migration Guide](.doc/MIGRATION_GUIDE.md) for more informations
`2.26.0` version includes a lot of changes and has different file structure, please go to [Migration Guide](.doc/MIGRATION_GUIDE.md) for more information

Latest Alpaca version supports work with Magento 2.4.3.<br>
If you use lower Magento versionb, check the [Changelog file](../CHANGELOG.md) to decide which version to use.<br>.
## Description
Alpaca Theme for Magento 2 is part of a `alpaca-packages`
To make it work with all features, we use following modules:

Open source
If you use lower Magento version, check the [Changelog file](./CHANGELOG.md) to decide which version to use.<br>
## Alpaca Packages
Alpaca Theme is a part of [Alpaca Packages](https://github.com/SnowdogApps/magento2-alpaca-packages) - a set of open source modules that cover Alpaca base features.
It includes:
* [magepal/magento2-gmailsmtpapp](https://github.com/magepal/magento2-gmail-smtp-app)
* [magepal/magento2-googletagmanager](https://github.com/magepal/magento2-google-tag-manager)
* [mailchimp/mc-magento2](https://github.com/mailchimp/mc-magento2)
Expand All @@ -23,31 +39,29 @@ Open source
* [snowdog/module-wishlist-unlocker](https://github.com/SnowdogApps/magento2-wishlist-unlocker)
* [webshopapps/module-matrixrate](https://github.com/webshopapps/module-matrixrate)

Alpaca supports also following OS modules:
* paradoxlabs/authnetcim
* paradoxlabs/tokenbase
* authorizenet/magento-module-creditcard
* [snowdog/module-alpaca-acm](https://github.com/SnowdogApps/magento2-alpaca-acm) - alpaca customisation for paid `blackbird/contentmanager` extension

Additional, non-opensource modules the theme works with to cover additional features:
* amasty/adminactionslog
* amasty/module-gdpr
* amasty/module-gift-card
* amasty/module-google-rich-snippets
* amasty/module-product-feed
* amasty/module-shipping-rules
* amasty/module-special-promo
* amasty/module-store-locator
* amasty/payrestriction
* amasty/shiprestriction
* apptrian/facebook-pixel
* blackbird/contentmanager
* vladimirpopov/webforms

## What Alpaca is?
Alpaca is a Magento 2 theme based on components system.
## Third-party module compatibility
Besides modules included in [Alpaca Packages](#alpaca-packages), Alpaca supports the following modules:
* Open source:
* paradoxlabs/authnetcim
* paradoxlabs/tokenbase
* authorizenet/magento-module-creditcard
* [snowdog/module-alpaca-acm](https://github.com/SnowdogApps/magento2-alpaca-acm) - Alpaca customisations for paid `blackbird/contentmanager` extension
* Non-open source modules the theme works with to cover additional features:
* amasty/adminactionslog
* amasty/module-gdpr
* amasty/module-gift-card
* amasty/module-google-rich-snippets
* amasty/module-product-feed
* amasty/module-shipping-rules
* amasty/module-special-promo
* amasty/module-store-locator
* amasty/payrestriction
* amasty/shiprestriction
* apptrian/facebook-pixel
* blackbird/contentmanager
* vladimirpopov/webforms

### Alpaca features:
### Key features
* Components system, build with fractal as a separate tool, on which you can work outside of Magento. You can customise it with variables or change and overwrite whole components.
* SVG icons - easily used also in CMS content
* Menu build with [Snowdog Module Menu](https://github.com/SnowdogApps/magento2-menu)
Expand All @@ -59,10 +73,3 @@ And much more. Check how to work with different features in [Working with Alpaca

## Installation
Check [Alpaca installation step by step guide](./docs/alpaca-step-by-step.md)

## Alpaca preview

* [Alpaca components preview](https://magento2-alpaca-theme-git-master-snowdog1.vercel.app/)
* [Alpaca theme on Magento 2 Community](https://alpaca-community.snowdog.dev/)
* [Alpaca theme on Magento 2 Commerce](https://alpaca-commerce.snowdog.dev/)

0 comments on commit 58bba83

Please sign in to comment.