|
8 | 8 | <h3 align="center">CMS Connect App for Magento
|
9 | 9 | </h3>
|
10 | 10 |
|
11 |
| -VueFront is a <a href="//vuejs.org">Vue-powered</a> agnostic frontend web app for your old fashioned Blog and Ecommerce site. |
| 11 | +<p align="center"> |
| 12 | + <a href="https://github.com/vuefront/vuefront"><img src="https://img.shields.io/badge/price-FREE-0098f7.svg" alt="Version"></a> |
| 13 | + <a href="https://packagist.org/packages/vuefront/module-vuefront"><img src="https://poser.pugx.org/vuefront/module-vuefront/v/stable" /></a> |
| 14 | + <a href="https://discord.gg/C9vcTCQ"><img src="https://img.shields.io/badge/chat-on%20discord-7289da.svg" alt="Chat"></a> |
| 15 | +</p> |
| 16 | + |
| 17 | +<p align="center"> |
| 18 | +Show your :heart: - give us a :star: <br/> |
| 19 | +Help us grow this project to be the best it can be! |
| 20 | + </p> |
| 21 | + |
| 22 | +__VueFront__ is a <a href="//vuejs.org">VueJS powered</a> CMS agnostic SPA & PWA frontend for your old-fashioned Blog and E-commerce site. |
| 23 | + |
| 24 | +__Magento__ empowers thousands of retailers and brands with the best eCommerce platforms and flexible cloud solutions to rapidly innovate and grow. |
12 | 25 |
|
13 |
| -Magento empowers thousands of retailers and brands with the best eCommerce platforms and flexible cloud solutions to rapidly innovate and grow. |
| 26 | +__CMS Connect App__ - adds the connection between the Magento CMS and VueFront Web App via a GraphQL API. |
| 27 | + |
| 28 | +# What does it do? |
| 29 | +This is a Magento module that connects the Magento CMS with the VueFront Web App via a GraphQL API. When installed, you will be provided with a CMS Connect URL that you will add to your VueFront Web App during [setup](https://vuefront.com/guide/setup.html). |
| 30 | + |
| 31 | +## Demo |
14 | 32 |
|
15 |
| -CMS Connect App - adds the connection between the Magento CMS and VueFront WebApp via a GraphQL API. |
| 33 | +[VueFront on Magento](https://magento.vuefront.com/) |
16 | 34 |
|
17 |
| -[](https://packagist.org/packages/vuefront/module-vuefront) |
18 |
| -[](https://packagist.org/packages/vuefront/module-vuefront) |
| 35 | +### Magento Blog (Megafan Blog Module) |
| 36 | +Since Magento does not have a built-in Blog, we use [Megafan Blog Module](https://marketplace.magento.com/magefan-module-blog.html) to add blog support automatically. If the Megafan Blog Module is not avalible, VueFront will ignore it. |
19 | 37 |
|
20 |
| -## How to install & upgrade VueFront |
21 | 38 |
|
22 |
| -### 1. Install via composer (recommend) |
| 39 | +## How to install? |
| 40 | + |
| 41 | +### 1. Quick Install via composer (recommended) |
23 | 42 |
|
24 | 43 | We recommend you to install VueFront module via composer. It is easy to install, update and maintaince.
|
25 | 44 |
|
@@ -47,15 +66,24 @@ Run compile if your store in Product mode:
|
47 | 66 | php bin/magento setup:di:compile
|
48 | 67 | ```
|
49 | 68 |
|
50 |
| -### 2. Copy and paste |
| 69 | +### 2. Install vie copy/paste |
51 | 70 |
|
52 | 71 | If you don't want to install via composer, you can use this way.
|
53 | 72 |
|
54 |
| -- Download [the latest version here](https://github.com/vuefront/vuefront/archive/master.zip) |
| 73 | +- Download [the latest version here](https://github.com/vuefront/magento/archive/master.zip) |
55 | 74 | - Extract `master.zip` file to `app/code/Vuefront/Vuefront` ; You should create a folder path `app/code/Vuefront/Vuefront` if not exist.
|
56 | 75 | - Go to Magento root folder and run upgrade command line to install `Vuefront`:
|
57 | 76 |
|
58 | 77 | ```
|
59 | 78 | php bin/magento setup:upgrade
|
60 | 79 | php bin/magento setup:static-content:deploy
|
61 | 80 | ```
|
| 81 | + |
| 82 | + |
| 83 | +## Support |
| 84 | +For support please contact us at [Discord](https://discord.gg/C9vcTCQ) |
| 85 | + |
| 86 | +## Submit an issue |
| 87 | +For submiting an issue, please create one in the [issues tab](https://github.com/vuefront/vuefront/issues). Remember to provide a detailed explanation of your case and a way to reproduce it. |
| 88 | + |
| 89 | +Enjoy! |
0 commit comments