Skip to content

Commit 60ccfd2

Browse files
committed
Merge branch 'master' of https://github.com/vuefront/magento
2 parents 9ca076d + 932df40 commit 60ccfd2

File tree

1 file changed

+37
-9
lines changed

1 file changed

+37
-9
lines changed

README.md

Lines changed: 37 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -8,18 +8,37 @@
88
<h3 align="center">CMS Connect App for Magento
99
</h3>
1010

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.
1225

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
1432

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/)
1634

17-
[![Latest Stable Version](https://poser.pugx.org/mageplaza/module-core/v/stable)](https://packagist.org/packages/vuefront/module-vuefront)
18-
[![Total Downloads](https://poser.pugx.org/vuefront/module-vuefront/downloads)](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.
1937

20-
## How to install & upgrade VueFront
2138

22-
### 1. Install via composer (recommend)
39+
## How to install?
40+
41+
### 1. Quick Install via composer (recommended)
2342

2443
We recommend you to install VueFront module via composer. It is easy to install, update and maintaince.
2544

@@ -47,15 +66,24 @@ Run compile if your store in Product mode:
4766
php bin/magento setup:di:compile
4867
```
4968

50-
### 2. Copy and paste
69+
### 2. Install vie copy/paste
5170

5271
If you don't want to install via composer, you can use this way.
5372

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)
5574
- Extract `master.zip` file to `app/code/Vuefront/Vuefront` ; You should create a folder path `app/code/Vuefront/Vuefront` if not exist.
5675
- Go to Magento root folder and run upgrade command line to install `Vuefront`:
5776

5877
```
5978
php bin/magento setup:upgrade
6079
php bin/magento setup:static-content:deploy
6180
```
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

Comments
 (0)