Skip to content

Commit 57b502b

Browse files
committed
updated guide
1 parent 1263c03 commit 57b502b

File tree

10 files changed

+117
-100
lines changed

10 files changed

+117
-100
lines changed

.vuepress/components/themeLayout.vue

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,19 +7,19 @@
77
<img
88
src="https://themes.getbootstrap.com/wp-content/uploads/2019/03/preview_screenshot-600x450.jpg"
99
>
10-
<h4>Defualt theme</h4>
10+
<h4>Default theme</h4>
1111
<p>The default theme for VueFront</p>
1212
</div>
1313
<div class="col">
1414
<img src="https://themes.getbootstrap.com/wp-content/uploads/2019/03/screenshot-1.png">
15-
<h4>Defualt theme</h4>
15+
<h4>Default theme</h4>
1616
<small>The default theme for VueFront</small>
1717
</div>
1818
<div class="col">
1919
<img
2020
src="https://themes.getbootstrap.com/wp-content/uploads/2018/02/BS_Marketing-768x576.png"
2121
>
22-
<h4>Defualt theme</h4>
22+
<h4>Default theme</h4>
2323
<small>The default theme for VueFront</small>
2424
</div>
2525
</div>
@@ -29,24 +29,24 @@
2929
<img
3030
src="https://themes.getbootstrap.com/wp-content/uploads/2018/05/front-preview-screenshot.jpg"
3131
>
32-
<h4>Defualt theme</h4>
32+
<h4>Default theme</h4>
3333
<small>The default theme for VueFront</small>
3434
</div>
3535
<div class="col">
3636
<img src="https://themes.getbootstrap.com/wp-content/uploads/2019/03/leap-1200x900.png">
37-
<h4>Defualt theme</h4>
37+
<h4>Default theme</h4>
3838
<small>The default theme for VueFront</small>
3939
</div>
4040
</div>
4141
<div class="row">
4242
<div class="col">
4343
<img src="https://themes.getbootstrap.com/wp-content/uploads/2018/09/screenshot-1.png">
44-
<h4>Defualt theme</h4>
44+
<h4>Default theme</h4>
4545
<small>The default theme for VueFront</small>
4646
</div>
4747
<div class="col">
4848
<img src="https://themes.getbootstrap.com/wp-content/uploads/2019/02/screenshot.jpg">
49-
<h4>Defualt theme</h4>
49+
<h4>Default theme</h4>
5050
<small>The default theme for VueFront</small>
5151
</div>
5252
</div>

.vuepress/config.js

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,16 @@ module.exports = {
1717
docsDir: 'docs',
1818
sidebar: {
1919
"/guide/": getSideBar(),
20-
"/develop/": getSideBar(),
20+
"/develop/": [{
21+
title: "Develop",
22+
collapsable: false,
23+
children: [
24+
'/develop/',
25+
'/develop/config',
26+
'/develop/theme',
27+
'/develop/app'
28+
]
29+
}],
2130
"/community/": getSideBar(),
2231
"/cms/": [{
2332
title: "CMS Extensions",
@@ -33,6 +42,7 @@ module.exports = {
3342
nav: [
3443
{ text: 'Home', link: '/' },
3544
{ text: 'Guide', link: '/guide/' },
45+
{ text: 'Develop', link: '/develop/' },
3646
{ text: 'CMS Connect', link: '/cms/' },
3747
{ text: 'Themes', link: '/themes/' },
3848
{ text: 'Apps', link: '/apps/' },
@@ -52,16 +62,6 @@ function getSideBar() {
5262
'/guide/setup'
5363
]
5464
},
55-
{
56-
title: "Develop",
57-
collapsable: false,
58-
children: [
59-
'/develop/',
60-
'/develop/store',
61-
'/develop/theme',
62-
'/develop/cms'
63-
]
64-
},
6565
{
6666
title: "Community",
6767
collapsable: false,

README.md

Lines changed: 26 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -11,29 +11,46 @@ heroImage: /logo.png
1111
actionText: Get Started →
1212
actionLink: /guide/
1313
features:
14-
- title: Works with your site
14+
- title: You can use it today
1515
details: Compatible with Wordpress, Woocommerce, Shopify, Magento, Drupal, Joomla, Opencart and more.
1616
- title: Build for the future
1717
details: Single Page application (SPA) and Progressive Web App (PWA) out of the box.
18-
- title: Simply beautiful
19-
details: It just works. We took out the hard stuff and made it easy to use.
18+
- title: It just works
19+
details: We took the liberty of making a complete solution from creating the back-end GraphQL module to building the front-end web app.
2020

2121
footer: MIT Licensed | Copyright © 2018-present Dreamvention
2222
---
2323

24-
### As Easy as 1, 2, 3
24+
### See the Demos
2525

26-
1. Install VueFront CMS Extension on your site (Opencart, Worpdress/WooCommerce)
27-
2. Install VueFront app. (requires node.js >= 8, git, and yarn)
26+
1. Wordpress + WooCommerce demo
27+
- [VueFront](https://wordpress.vuefront.com/)
28+
- [Admin](https://wordpress.vuefront.com/wp-admin)
29+
30+
2. OpenCart + Blog Module demo
31+
- [VueFront](https://opencart.vuefront.com/)
32+
- [Admin](https://opencart.vuefront.com/admin)
33+
34+
35+
### Installing is as easy as 1, 2, 3
36+
37+
1. [Download](/cms/) and Install VueFront **CMS Connect App** on your site ([OpenCart](/cms/opencart.html), [Worpdress/WooCommerce](/cms/wordpress.html)) the app will provide you with a CMS Connect URL.
38+
2. In command line install VueFront Web App. (requires node.js >= 8 and yarn or npm)
2839

2940
```bash
3041
# Create VueFront app. replace <project-name> with vuefront
3142
yarn create vuefront-app <project-name>
3243
# OR npx create-vuefront-app <project-name>
3344

3445
yarn dev
46+
# OR npm run dev
47+
```
48+
49+
- When prompt during the setup step, paste the CMS Connect URL provided by CMS Connect App.
50+
51+
```bash
52+
# during the setup you will be asked to paste the CMS Connect URL:
53+
? Paste the CMS Connect URL, provided by your CMS Connect App ()
3554
```
3655

37-
::: warning COMPATIBILITY NOTE
38-
VueFront requires Node.js >= 8.
39-
:::
56+
Enjoy your new VueFront!

cms/opencart.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,3 +10,10 @@ meta:
1010
---
1111

1212
# OpenCart
13+
14+
| Version | Link |
15+
|-------------|----------|
16+
| 3.0.x | download |
17+
| 2.3.x | download |
18+
| 2.0.x-2.2.x | download |
19+
| 1.5.x | download |
Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: CMS connect
2+
title: App development
33
lang: en-US
44
sidebarDepth: 2
55
meta:
@@ -9,4 +9,4 @@ meta:
99
content: vuefront, vuejs, nuxt, agnostic framework, documentation
1010
---
1111

12-
# How to develop a CMS connect App
12+
# App development
Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Store
2+
title: Config file
33
lang: en-US
44
sidebarDepth: 2
55
meta:
@@ -9,4 +9,4 @@ meta:
99
content: vuefront, vuejs, nuxt, agnostic framework, documentation
1010
---
1111

12-
# Store
12+
# Config file

guide/README.md

Lines changed: 34 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -8,72 +8,71 @@ meta:
88
- name: keywords
99
content: vuefront, vuejs, nuxt, agnostic framework, documentation
1010
---
11-
12-
# What is VueFront?
11+
# VueFront - CMS Agnostic Front-end
12+
## What is VueFront?
1313

1414
> “Simple can be harder than complex: You have to work hard to get your thinking clean to make it simple. But it’s worth it in the end because once you get there, you can move mountains.” ~ Steve Jobs
1515
16-
__For website owners__
17-
VueFront lets you lets your old fashioned site into the future. You get to keep your current admin panel while upgrading to a compleatly new beautiful frontend, build on new technology: extreamly fast, no more page refresh, can work off-line, can be saved to homescreen like an mobile app and it's unbelievably extensible
16+
VueFront is a Vue powered CMS agnostic front-end framework that allows owners and developers of an old-fashioned blog or e-commerce site to quickly switch to a SPA progressive web app.
1817

19-
__For developers__
20-
VueFront is a free open-source vue powered agnistic frontend framework. It works straight out of the box with the most popular CMS like wordpress & woocommerce, magenta, opencart, prestashop. It is built on Vuejs and works great together with Nuxt or Vue Cli. It is by default an SPA (single page application) with a option to turn into a PWA (progressiv web app).
18+
It is open-source with MIT license so you are free to modify it as you wish.
2119

2220
::: tip
23-
Want to see how your current site looks in VueFront? Follow our simple [5 minute setup](/guide/setup.html)
21+
Want to see how your current site looks in VueFront? Follow our simple [5-minute setup](/guide/setup.html)
2422
:::
2523

26-
Currently we maintaine support for the following website/blogging and E-commerce CMS backends:
24+
## Who is it for?
25+
26+
Anyone from a basic Wordpress & Woocommerce user, OpenCart or Magenta webshop owner to a professional PrestaShop or Shopify Developer.
27+
28+
You can install and use VueFront today. The setup takes less than 5 minutes. You won't need to delete anything or make costly migrations. All you need is a computer with Nodejs & Yarn (or NPM) installed and access to your old-fashioned website files.
29+
30+
## What CMS's are supported
2731

32+
Currently, we maintain support for the following website/blogging and E-commerce CMS backends:
2833
- Wordpress + WooCommerce
2934
- OpenCart + Blog Module
35+
36+
In development...
3037
- Prestashop + PrestaBLog
38+
- Magento
3139

3240
Soon to come...
33-
34-
- Magento
3541
- Joomla
3642
- Drupal + DrupalCommerce
3743
- Shopify
3844
- BigCommerce
3945
- Volusion
4046

41-
## Why use VueFront?
42-
47+
## What do I get out-of-the-box?
4348
> “Everything should be made as simple as possible, but not simpler.” ~ Albert Einstein
4449
45-
In the core of VueFront lies the concept __Decoupling and Symplicity__.
46-
47-
In modern web development, monolithic applications have been divided into smaller simpler parts, where each one is often outsorced to specilized teams and services. VueFront is one of them. It allows you to decouple your monolithic web application, which could be your current CMS like wordpress or shopify and outsource the frontend. You get a new shiny SPA front, while keeping your usual backend and your business flow.
50+
VueFront was created as a fully functional Blog & E-commerce web app. You get a working new single-page application with the possibility to turn it into a progressive web app.
4851

49-
**Here are five key features of VueFront, that will make your mouth**
52+
In other words, you get a cool new website that is:
5053

51-
- Backend Agnostic (works with many website/blogging/eccomerce CMS out of the box).
52-
- Modern (Built with Vue on Nuxt or Vue Cli, utilizing GraphQL).
53-
- An SPA and PWA (Single Page Application & Progressive Web App).
54-
- Extensible (allows Themes, Apps, and easy upgrades).
55-
- Well documented (we know how importent documentation is).
54+
- Super fast
55+
- SEO friendly
56+
- Offline ready
57+
- Modern
5658

57-
## Backend Agnostic
59+
For more tech-savvy ones:
5860

59-
Infographics here...
61+
**Here are five key features of VueFront, that will make your mouth water**
6062

61-
1. Frontend Web App is built with Vue on Nuxt or Vue Cli, which implements SPA and PWA.
62-
2. The store is managed by Vuex and an Apollo client
63-
3. On the Backend a CMS corresponding module is installed and a GraphQL API is setup via Apollo
64-
4. VueFront makes all requests to the Apollo API endpoint and displays the data accordingly.
65-
66-
### What are the trade-offs?
63+
- Backend Agnostic (works with many websites/blogging/eCommerce CMS out of the box).
64+
- Modern (Built with Vue on Nuxt or Vue Cli, utilizing GraphQL).
65+
- SPA and PWA (Single Page Application & Progressive Web App).
66+
- Extensible (allows Themes, Apps, and easy upgrades).
67+
- Well documented (we know how important documentation is).
6768

68-
Since we are implementing one standard for all websites/blogs/ecommerce sites, there must be some trade-offs.
69+
## How to develop for it?
6970

70-
- Unique features of a CMS may not be avalible out of the box.
71-
- Customizations done to the old frontend will have to be reimplemented on the new VueFront
72-
- A higher learning curve for developers used to old CMSs, mostly php.
71+
One of its key features is extensibility. You can create custom themes and apps for VueFront or use third-party developed.
7372

74-
All of these limitations are being removed thanks to a growing community of VueFront creators, who develope new extensions and features, improving the VueFront ecosystem.
73+
When developing for VueFront you won't be editing the core files, rather extending them to add new features and themes. This makes future upgrades simple, keeping your codebase up to date. You get code splitting, asset optimization, progressive images, and link prefetching out of the box.
7574

76-
At the end of the day, an open-source project is all about the community around it.
75+
For more information read the [Developer's guide](/develop/)
7776

7877
::: tip
7978
Want to do more with VueFront? Become a [VueFront Creator](/support.html).

guide/setup.md

Lines changed: 16 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ meta:
1010
---
1111

1212
# Quick Setup
13-
Try our 5 minute setup
13+
Try our 5-minute setup
1414

1515
1. Install CMS Connect App. [Download and install your CMS Connect app →](/cms/)
1616

@@ -25,37 +25,30 @@ yarn dev
2525

2626
## Step 1. Install CMS Connect App
2727

28-
For VueFront to have access to your website data, you need to install a CMS Connect App that will provide a GraphQL API endpoint. VueFront will then to fetch all the data from your website like any other webapp. CMS Connect APP also adds the required functionality such as submiting reviews, adding products to cart, checkout etc.
28+
For VueFront to have access to your website data, you need to install a CMS Connect App that will provide a GraphQL API endpoint. VueFront will then to fetch all the data from your website like any other web app. CMS Connect APP also adds the required functionality such as submitting reviews, adding products to cart, checkout, etc.
2929

3030
- Wordpress/Woocommerce
3131
- OpenCart
3232

3333
[view all CMS Connect Apps →](/cms/)
3434

35-
The CMS Connect App will provide you with your API Url. You will need it on the next step, when installing VueFront
35+
The CMS Connect App will provide you with your API Url. You will need it on the next step when installing VueFront
3636

3737
::: tip
3838
Didn't find a `CMS Connect` App for your current website. No biggy. Simply [send us a request](/support.html) and we will be happy to create one for you.
3939
:::
4040

4141
## Step 2. Install VueFront
4242

43-
VueFront is a Single page application that needs to be hosted on a NodeJs server for Server-side rendering. It requires the follwoing:
43+
VueFront is a Single page application that needs to be hosted on a NodeJs server for Server-side rendering. It requires the following:
4444

4545
- nodejs >= 8
4646
- yarn (or nmp)
4747

48-
49-
VueFront consists of the following modules:
50-
51-
1. [vuefront (Github)](https://github.com/vuefront/vuefront)
52-
2. [vuefront-nuxt (Github)](https://github.com/vuefront/vuefront-nuxt)
53-
3. [vuefront-cli (Github)](https://github.com/vuefront/vuefront-cli)
54-
55-
After you have installed the CMS extension, activated it and recieved the API Url, you can now install VueFront.
48+
After you have installed the CMS extension, activated it and received the **CMS Connect Url**, you can now install VueFront.
5649

5750
```bash
58-
# Create VueFront app. replace <project-name> with vuefront
51+
# Create VueFront app. replace <project-name> with vuefront or ./ for selected folder
5952
yarn create vuefront-app <project-name>
6053
# OR npx create-vuefront-app <project-name>
6154

@@ -69,13 +62,18 @@ After you have launched the app in `dev mode`, you should see your site at [http
6962

7063

7164
### Create-vuefront-app
72-
For a simpler installation process we have provided [create-vuefront-app](https://github.com/vuefront/create-vuefront-app), which helps you setup your vuefront with ease.
7365

74-
It will ask you several questions to configure your vuefront app.
66+
VueFront consists of the following modules:
67+
68+
1. [vuefront (Github)](https://github.com/vuefront/vuefront)
69+
2. [vuefront-nuxt (Github)](https://github.com/vuefront/vuefront-nuxt)
70+
3. [vuefront-cli (Github)](https://github.com/vuefront/vuefront-cli)
71+
72+
For a simpler installation process, we have provided [create-vuefront-app](https://github.com/vuefront/create-vuefront-app), which helps you set up your vuefront with ease.
73+
74+
It will ask you several questions to configure your VueFront app.
7575

7676
### Recommendations
7777
When installing VueFront, we recommend sticking to the following rules:
7878
1. using always `yarn` as the default package manager
79-
2. using `vue cli` as your vue framework for new users and `nuxt` for advanced users.
80-
81-
79+
2. using `vue cli` as your Vue framework for new users and `nuxt` for advanced users.

package.json

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,15 @@
88
"scripts": {
99
"dev": "vuepress dev"
1010
},
11+
"resolutions": {
12+
"webpack-dev-middleware": "3.6.0"
13+
},
1114
"dependencies": {
1215
"vuepress": "^0.14.11",
13-
"webpack-dev-middleware": "^3.6.2",
16+
"webpack-dev-middleware": "3.6.0",
1417
"webpack-dev-server": "^3.3.1"
18+
},
19+
"devDependencies": {
20+
"vuepress": "^0.14.11"
1521
}
16-
}
22+
}

0 commit comments

Comments
 (0)