Skip to content

Commit 585890a

Browse files
committed
2 parents 40171ef + b9d986f commit 585890a

File tree

2 files changed

+65
-19
lines changed

2 files changed

+65
-19
lines changed

README.md

Lines changed: 23 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,44 +1,54 @@
11
<p align="center">
22
<br>
33
<a href="https://vuefront.com">
4-
<img src="https://vuefront.com/logo.png" width="120"/>
4+
<img src="https://raw.githubusercontent.com/vuefront/vuefront-docs/master/.vuepress/public/img/github/vuefront-wordpress.jpg" width="400"/>
55
</a>
66
</p>
77
<h1 align="center">VueFront</h1>
8-
<h3 align="center">CMS Connect App for Wordpress
8+
<h3 align="center">CMS Connect App for WordPress
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://wordpress.org/plugins/vuefront/"><img src="https://img.shields.io/wordpress/plugin/v/vuefront" /></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>
1216

13-
Wordpress is open source software you can use to create a beautiful website, blog, or app.
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>
1421

15-
CMS Connect App - adds the connection between the Wordpress CMS and VueFront WebApp via a GraphQL API.
1622

17-
## What does it do?
18-
This is a wordpress plugin that connects the wordpress CMS with the VueFront WebApp via a GraphQL API. When installed, you will be provided with a CMS Connect URL that you will add to your VueFront WebApp .env file.
23+
__VueFront__ is a <a href="//vuejs.org">VueJS powered</a> CMS agnostic SPA & PWA frontend for your old-fashioned Blog and E-commerce site.
24+
25+
__WordPress__ is open source software you can use to create a beautiful website, blog, or app.
1926

20-
## DEMO
27+
__CMS Connect App__ - adds the connection between the WordPress CMS and VueFront WebApp via a GraphQL API.
28+
29+
# Demo
2130

22-
[VueFront](https://wordpress.vuefront.com/)
31+
[VueFront on Wordpress](https://wordpress.vuefront.com/)
2332

24-
[Admin](https://wordpress.vuefront.com/admin)
33+
## What does it do?
34+
This is a wordpress plugin that connects the wordpress CMS with the VueFront WebApp via a GraphQL API. When installed, you will be provided with a CMS Connect URL that you will add to your VueFront WebApp .env file.
2535

2636
### Wordpress Store (WooCommerce)
2737
Since Wordpress does not have a built-in Store, we use the [Free WooCommerce](https://woocommerce.com/) to add store support. If woocommerce is not avalible, VueFront will ignore it.
2838

2939
## How to install?
3040

3141
### Quick Install
32-
1. The quickest way to install is via WordPress Plugin Directory or manually [Download](https://github.com/vuefront/wordpress/releases) the **compiled** plugin and upload it through the 'Plugins > Add New' menu in WordPress
42+
1. The quickest way to install is via [WordPress Plugin Directory](https://wordpress.org/plugins/vuefront/) or manually [Download](https://github.com/vuefront/wordpress/releases) the **compiled** plugin and upload it through the 'Plugins > Add New' menu in WordPress
3343
2. Activate the plugin through the 'Plugins' menu in WordPress
3444
3. Visit plugin's settings to get the CMS Connect URL
3545

3646
You will need the CMS Connect URL to complete the [VueFront Web App installation](https://vuefront.com/guide/setup.html)
3747

3848
## Support
39-
For support please contact us a https://dreamvention.ee/support
49+
For support please contact us at [Discord](https://discord.gg/C9vcTCQ)
4050

4151
## Submit an issue
42-
For submiting an issue, please create one in the [issues tab](https://github.com/vuefront/wordpress/issues). Remember to provide a detailed explanation of your case and a way to reproduce it.
52+
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.
4353

4454
Enjoy!

readme.txt

Lines changed: 42 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,65 @@
11
=== VueFront ===
22
Contributors: vuefront
3-
Donate link: http://vuefront.com/
4-
Tags: vuefront, cms, vuejs, nuxt, webapp, graphql, frontend, framework, blog, ecommerce
3+
Donate link: https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=D36ENUWPNA3KG&source=url
4+
Tags: pwa, spa, woocommerce, amp, jamstack, ajax, vuefront, cms, vuejs, nuxt, webapp, graphql, frontend, framework, blog, ecommerce, single page application
55
Requires at least: 4.0.0
66
Tested up to: 5.2.1
77
Requires PHP: 5.5.0
88
Stable tag: 1.1.0
99
License: GPLv2
1010
License URI: http://www.gnu.org/licenses/gpl-2.0.html
1111

12-
VueFront plugin allows you to connect Wordpress & Woocommerce with VueFront WebApp via a GraphQL API.
12+
Free SPA & PWA for WordPress & Woocommerce with AMP & GraphQL.
1313

1414
== Description ==
15-
This plugin is a VuefRont CMS Connect App for Wordpress+Woocommerce and it adds the connection between the Wordpress CMS and VueFront WebApp via a GraphQL API.
15+
VueFront is a modern Frontend Framework that allows any WordPress and Woocommerce website to become a fast Single Page Application (SPA) and a Progressive Web App (PWA).
16+
17+
<a href="https://wordpress.vuefront.com/" title="VueFront Web App DEMO">DEMO: VueFront Web App</a>
18+
19+
VueFront Web App is built on JAMstack and comes with AMP, GraphQL, Vuejs, Nuxt inside.
20+
21+
The VueFront WordPress Plugin is required to add a GraphQL API to your website to feed the data into the Web App.
22+
When installed it will provide you with a CMS Connect URL. Use it to setup your VueFront Web App as discribed in the <a href="https://vuefront.com/guide/setup.html" title="VueFront Quick Setup Guide">VueFront Quick Setup Guide</a>.
1623

1724
== Installation ==
1825
1. You can either install this plugin from the WordPress Plugin Directory,
1926
or manually [download the plugin](https://github.com/vuefront/wordpress/releases) and upload it through the 'Plugins > Add New' menu in WordPress
2027
2. Activate the plugin through the 'Plugins' menu in WordPress
2128
3. Visit plugin's settings to get the CMS Connect URL
29+
4. Visit the <a href="https://vuefront.com/guide/setup.html" title="VueFront setup guide">VueFront Setup Guide</a> to learn how to setup the Web App on step 2.
30+
31+
== Upgrade Notice ==
32+
To upgrade simply click upgrade or upload the new version via "add new" plugin. The VueFront Plugin is smart and will apply all the changes on first load.
2233

2334
== How to Use ==
24-
Once the plugin is activated, the CMS Connect URL will function automatically, providing VueFront Webapp access to the website data.
35+
Once the plugin is activated, the CMS Connect URL will function automatically, providing VueFront Web App access to the website data.
36+
37+
If you have WooCommerce installed and activated, the plugin will automatically provide that data as well.
38+
39+
You do not need to do anything from the admin panel. It should work out-of-the-box.
40+
41+
Just enjoy the new SPA.
42+
43+
== Screenshots ==
44+
1. VueFront is a Single Page Application for WordPress
45+
2. VueFront is SEO ready and loved by google for PWA & AMP
46+
3. VueFront works off-line with service workers
47+
4. VueFront supports WooCommerce
48+
5. VueFront is built on JAMstak, VueJS, Nuxt, GraphQL
49+
6. VueFront is super fast, off-line ready, seo ready
50+
7. VueFront is the #1 PWA solution for WordPress and WooCommerce
51+
52+
53+
== Frequently Asked Questions ==
54+
= What do I do after I have installed the plugin? =
55+
The plugin will provide you with a CMS Connect URL. The next step is to install the Web app via the command line. It is actually very simple to do. Just fillow <a href="https://vuefront.com/guide/setup.html" title="VueFront Setup Tutorial">setup tutorial</a>.
56+
57+
= When I visit the CMS Connect URL, I see this error {"errors":[{"message":"Syntax Error GraphQL (1:1) Unexpected nn1: n ^n","category":"graphql","locations":[{"line":1,"column":1}]}]} =
58+
This is absolutly fine. It is a normal responce from GraphQL API saying you have not provided any details in you request. Continue with setting up the VueFront WebApp https://vuefront.com/guide/setup.html
59+
60+
= I have setup the VueFront WebApp via the command line, but the site is not working. What do I do? =
61+
This is a very young technology and there could be version breaks. The first thing you should do is visit our <a href="https://github.com/vuefront/vuefront/issues" title="Github Issues">Github Issues</a> and search for help. If not found, create a new Issue and a developer will help you.
2562

26-
If you have Woocommerce installed and activated, the plugin will provide that data as well.
2763

2864
== Changelog ==
2965
= 1.1.0 =

0 commit comments

Comments
 (0)