From 6e4319521e6072550810fcce72e38cabb6af8c8b Mon Sep 17 00:00:00 2001 From: Oksydan Date: Wed, 2 Jun 2021 15:52:37 +0200 Subject: [PATCH] Installation instruction fix, yml fix, version bump --- README.md | 35 +++++++++++++++++++++++++++-------- _dev/package.json | 2 +- config/theme.yml | 9 +-------- 3 files changed, 29 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index 4504e829..95339707 100644 --- a/README.md +++ b/README.md @@ -57,9 +57,13 @@ This theme was created to deliver starter theme with latest developers tools and ### Installation -1. Clone or download repository. Make sure to remove branch name (`master`). +1. Go to [releases](https://github.com/Oksydan/modern-prestashop-starter-theme/releases/) and download latest version `starter.zip` file not source code. + 2. Download required modules and place them into `{shop_dir}/modules/` folder. Make sure that folder name of module don't contain branch name. -3. If you want to change theme name unzip file. Change folder name e.g. `your-theme-name` then go to `config/theme.yml` and change: + +3. Unzip theme file and place it inside `{shop_dir}/themes/`. + +4. If you want to change theme name unzip file. Change folder name e.g. `your-theme-name` then go to `config/theme.yml` and change: ```yml name: starter display_name: display @@ -70,9 +74,9 @@ to: name: your-theme-name display_name: my theme display name ``` -Name in `theme.yml` must be equal folder name. Zip theme folder and install theme from prestashop BO. +Name in `theme.yml` must be equal folder name. -4. If you changed theme name you have to go to `is_themecore` module. Find `hookActionFrontControllerSetMedia` method and change: +5. If you changed theme name you have to go to `is_themecore` module. Find `hookActionFrontControllerSetMedia` method and change: ```php $themeAssetsObject = new ThemeAssets($pageName, 'starter', $this->context); ``` @@ -80,7 +84,8 @@ to: ```php $themeAssetsObject = new ThemeAssets($pageName, 'your-theme-name', $this->context); ``` -5. Open in terminal directory `your-theme-name/_dev` and run: + +6. Open in terminal directory `your-theme-name/_dev` and run: - for `npm` : ``` npm install @@ -89,8 +94,22 @@ npm install ``` yarn install ``` -6. Go to `your-theme-name/_dev/webpack` and find `.env-example`. Copy file and rename it with `.env`. Replace example value with proper one based on your setup. -7. Now try to run: + +7. Go to `your-theme-name/_dev/webpack` and find `.env-example`. Copy file and rename it with `.env`. Replace example value with proper one based on your setup. + +8. Now try to run: +- for `npm` : +``` +npm run build +``` +- for `yarn` : +``` +yarn build +``` + +9. Go in BO to Design->Theme & Logo and turn on theme. Now starter should be displayed correctly in FO and modules should be installed. + +10. Now try to run: - for `npm` : ``` npm run dev @@ -99,7 +118,7 @@ npm run dev ``` yarn dev ``` -If your `.env` file is correctly setup. Your browser will open front office of your store. +If your `.env` file is correctly setup. Your browser will open FO of your store. ## Usage diff --git a/_dev/package.json b/_dev/package.json index b5affa40..84dd8d9f 100644 --- a/_dev/package.json +++ b/_dev/package.json @@ -1,6 +1,6 @@ { "name": "modern-prestashop-build-tool", - "version": "1.0.3", + "version": "1.1.1", "description": "Modern tools that help you develop your theme.", "main": "index.js", "scripts": { diff --git a/config/theme.yml b/config/theme.yml index 88350657..734c23f0 100644 --- a/config/theme.yml +++ b/config/theme.yml @@ -1,6 +1,6 @@ name: starter display_name: starter theme -version: 1.0.3 +version: 1.1.1 author: name: "Igor Stępień" email: "igor@istepien.dev" @@ -132,10 +132,3 @@ theme_settings: new-products: layout-left-column prices-drop: layout-left-column contact: layout-left-column - -dependencies: - modules: - - is_themecore - - is_shoppingcart - - is_imageslider - - is_searchbar