Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/scandipwa/installer

Last synced: 14 days ago
JSON representation

Host: GitHub
URL: https://github.com/scandipwa/installer
Owner: scandipwa
License: osl-3.0
Created: 2019-03-08T14:38:10.000Z (over 5 years ago)
Default Branch: master
Last Pushed: 2023-03-13T21:07:42.000Z (over 1 year ago)
Last Synced: 2024-11-01T09:49:19.502Z (19 days ago)
Language: PHP
Size: 33.2 KB
Stars: 6
Watchers: 7
Forks: 9
Open Issues: 2
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

# ScandiPWA installer
[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fscandipwa%2Finstaller.svg?type=shield)](https://app.fossa.io/projects/git%2Bgithub.com%2Fscandipwa%2Finstaller?ref=badge_shield)

Module is a helper to install ScandiPWA Theme.

## 2.0.0
Finally theme bootstrap does not rely on Magento state and `scandipwa:theme:bootstrap` does not require additional
setup:upgrade or initialized magento to be called.

Now copying queue is defined in Bootstrap.php directly to support non-initialized Magento states and DB-less
bootstrap and build.

## Usage

1) `composer require scandipwa/installer`

2) `php bin/magento scandipwa:theme:bootstrap `

### New theme bootstrap

Command accepts single parameter, which is treated as following format: "Vendor/theme".

**Note**

*You can change `Scandiweb/pwa` in examples below to anything suitable for you, keeping the same naming structure:
`Vendor/theme_name`*

After `php bin/magento scandipwa:theme:bootstrap Scandiweb/pwa` it will make next effect:
1. Check for `/app/design/frontend/Scandiweb/pwa` - bootstrap will quite with error if directory is present to prevent unwanted overrides.
2. Create `/app/design/frontend/Scandiweb/pwa` directory
3. Copy necessary files to the newly created theme root.
4. Answer y/N (No is default) to a prompt for `theme.xml` and `registration.php` generation. You might want to create
them manually - feel free to do it!
5. Run `php bin/magento setup:upgrade`.
6. You are bootstraped!

### Theme build
The theme must be built after it is bootstrap or after any changes.

1. Go to `app/design/frontend/`
2. run `npm ci`
3. run `npm run build`

#### Customization
In order to customize copying task - simply edit `di.xml`, passing array with paths.

## License
[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fscandipwa%2Finstaller.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fscandipwa%2Finstaller?ref=badge_large)