You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+45-39Lines changed: 45 additions & 39 deletions
Original file line number
Diff line number
Diff line change
@@ -9,59 +9,65 @@
9
9
10
10
# This is currently a work in progress!
11
11
12
-
1. Install and activate the following required plugins, in your WordPress plugin directory:
12
+
1.Install and activate the following required plugins, in your WordPress plugin directory:
13
13
14
-
-[woocommerce](https://wordpress.org/plugins/woocommerce) Ecommerce for WordPress.
15
-
-[wp-graphql](https://wordpress.org/plugins/wp-graphql) Exposes GraphQL for WordPress.
16
-
-[wp-graphql-woocommerce](https://github.com/wp-graphql/wp-graphql-woocommerce) Adds WooCommerce functionality to a WPGraphQL schema.
17
-
-[algolia-woo-indexer](https://github.com/w3bdesign/algolia-woo-indexer) Sends WooCommerce products to Algolia. Required for search to work.
18
-
-[wp-graphql-cors](https://github.com/funkhaus/wp-graphql-cors) Ensures that CORS works correctly. Remember to add the domain to the store under `Extend "Access-Control-Allow-Origin” header`
14
+
-[woocommerce](https://wordpress.org/plugins/woocommerce) Ecommerce for WordPress.
15
+
-[wp-graphql](https://wordpress.org/plugins/wp-graphql) Exposes GraphQL for WordPress.
16
+
-[wp-graphql-woocommerce](https://github.com/wp-graphql/wp-graphql-woocommerce) Adds WooCommerce functionality to a WPGraphQL schema.
17
+
-[algolia-woo-indexer](https://github.com/w3bdesign/algolia-woo-indexer) Sends WooCommerce products to Algolia. Required for search to work.
18
+
-[wp-graphql-cors](https://github.com/funkhaus/wp-graphql-cors) Ensures that CORS works correctly. Remember to add the domain to the store under `Extend "Access-Control-Allow-Origin” header`
19
19
20
20
Optional plugin:
21
21
22
-
-[headless-wordpress](https://github.com/w3bdesign/headless-wp) Disables the frontend so only the backend is accessible. (optional)
22
+
-[headless-wordpress](https://github.com/w3bdesign/headless-wp) Disables the frontend so only the backend is accessible. (optional)
23
23
24
24
The current release has been tested and is confirmed working with the following versions:
25
25
26
-
- WordPress version 5.6.0
27
-
- WooCommerce version 4.9.0
28
-
- WP GraphQL version 1.1.2
29
-
- WooGraphQL version 0.6.1 (latest development version)
30
-
- WPGraphQL CORS version 1.1.0 (with introspection enabled)
26
+
-WordPress version 5.6.0
27
+
-WooCommerce version 4.9.0
28
+
-WP GraphQL version 1.1.2
29
+
-WooGraphQL version 0.6.1 (latest development version)
30
+
-WPGraphQL CORS version 1.1.0 (with introspection enabled)
Rename .env.example to .env so the Apollo debugger will correctly load. It will not load if the NODE_ENV variable is not correctly set.
38
+
Rename .env.example to .env so the Apollo debugger will correctly load. It will not load if the NODE_ENV variable is not correctly set.
39
39
40
-
3. Make sure WooCommerce has some products already or import some sample products
40
+
3.Make sure WooCommerce has some products already or import some sample products
41
41
42
-
The WooCommerce sample products CSV file is available at `wp-content/plugins/woocommerce/sample-data/sample_products.csv` or [Sample products](sample_products/)
42
+
The WooCommerce sample products CSV file is available at `wp-content/plugins/woocommerce/sample-data/sample_products.csv` or [Sample products](sample_products/)
43
43
44
-
Import the products at `WP Dashboard > Tools > Import > WooCommerce products(CSV)`
44
+
Import the products at `WP Dashboard > Tools > Import > WooCommerce products(CSV)`
45
45
46
-
4. Clone or fork the repo and modify `.env` with the URL to the GraphQL endpoint (or set environment variables in the configuration UI for your deployment solution)
47
-
5. Start the server with `npm run dev`
48
-
6. Enable COD (Cash On Demand) payment method in WooCommerce
49
-
7. Add a product to the cart
50
-
8. Proceed to checkout
51
-
9. Fill in your details and place the order
46
+
4. Clone or fork the repo and modify `.env` with the URL to the GraphQL endpoint (or set environment variables in the configuration UI for your deployment solution)
47
+
48
+
5. Start the server with `npm run dev`
49
+
50
+
6. Enable COD (Cash On Demand) payment method in WooCommerce
51
+
52
+
7. Add a product to the cart
53
+
54
+
8. Proceed to checkout
55
+
56
+
9. Fill in your details and place the order
52
57
53
58
## Features
54
59
55
-
- NuxtJS
56
-
- Tailwind CSS
57
-
- Vue Apollo with GraphQL Codegen
58
-
- Responsive design
59
-
- Support for simple products
60
-
- GraphQL-based filters
61
-
- CSS animations and transitions
62
-
- Form handling and validation with Vue Formulate
63
-
- Checkout process
64
-
- Animated mobile menu
60
+
- NuxtJS
61
+
- Tailwind CSS
62
+
- Vue Apollo with GraphQL Codegen
63
+
- Vue Awesome Swiper for image slider on frontpage
64
+
- Responsive design
65
+
- Support for simple products
66
+
- GraphQL-based filters
67
+
- CSS animations and transitions
68
+
- Form handling and validation with Vue Formulate
69
+
- Checkout process
70
+
- Animated mobile menu
65
71
66
72
## Troubleshooting
67
73
@@ -75,7 +81,7 @@ Check the attributes of the products. Right now the application requires Size an
75
81
76
82
## TODO
77
83
78
-
- Look into variable product support
79
-
- Make WooCommerce session token expire and get deleted after 24 hours
80
-
- Finish implementing Algolia search
81
-
- Make Algolia look good on mobile
84
+
-Look into variable product support
85
+
-Make WooCommerce session token expire and get deleted after 24 hours
0 commit comments