Skip to content

Commit a77a5d2

Browse files
committed
Prettier
1 parent fef6b31 commit a77a5d2

File tree

1 file changed

+30
-31
lines changed

1 file changed

+30
-31
lines changed

README.md

+30-31
Original file line numberDiff line numberDiff line change
@@ -1,57 +1,56 @@
11
[![Playwright Tests](https://github.com/w3bdesign/nuxtjs-woocommerce/actions/workflows/playwright.yml/badge.svg)](https://github.com/w3bdesign/nuxtjs-woocommerce/actions/workflows/playwright.yml)
2-
[![Codacy Badge](https://api.codacy.com/project/badge/Grade/1835e693354349ffaa703c0bbaf2b52b)](https://app.codacy.com/gh/w3bdesign/nuxtjs-woocommerce?utm_source=github.com\&utm_medium=referral\&utm_content=w3bdesign/nuxtjs-woocommerce\&utm_campaign=Badge_Grade)
2+
[![Codacy Badge](https://api.codacy.com/project/badge/Grade/1835e693354349ffaa703c0bbaf2b52b)](https://app.codacy.com/gh/w3bdesign/nuxtjs-woocommerce?utm_source=github.com&utm_medium=referral&utm_content=w3bdesign/nuxtjs-woocommerce&utm_campaign=Badge_Grade)
33
[![CodeFactor](https://www.codefactor.io/repository/github/w3bdesign/nuxtjs-woocommerce/badge)](https://www.codefactor.io/repository/github/w3bdesign/nuxtjs-woocommerce)
4-
[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=w3bdesign_nuxtjs-woocommerce\&metric=alert_status)](https://sonarcloud.io/dashboard?id=w3bdesign_nuxtjs-woocommerce)
4+
[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=w3bdesign_nuxtjs-woocommerce&metric=alert_status)](https://sonarcloud.io/dashboard?id=w3bdesign_nuxtjs-woocommerce)
55

66
# Nuxt 3 Ecommerce site with WooCommerce backend
77

88
<img src="https://user-images.githubusercontent.com/45217974/106988377-f129a080-676f-11eb-94b9-a44c86ea6c79.png" alt="Project screenshot" />
99

1010
## Table Of Contents (TOC)
1111

12-
* [Features](#Features)
13-
* [Installation](#Installation)
14-
* [Troubleshooting](#Troubleshooting)
15-
* [TODO](#TODO)
12+
- [Features](#Features)
13+
- [Installation](#Installation)
14+
- [Troubleshooting](#Troubleshooting)
15+
- [TODO](#TODO)
1616

1717
## Features
1818

19-
* Nuxt 3
20-
* Vue 3 and Composition API with <script setup> syntax
21-
* Tailwind CSS
22-
* Nuxt Apollo
23-
* Pinia with pinia-plugin-persistedstate for cart and state management
24-
* Responsive design
25-
* Swiper integration for Hero section
26-
* Support for simple and variable products
27-
* Stock quantity on simple and variable products
28-
* CSS animations and transitions
29-
* Form handling and validation with Formkit, Vee Validate and Yup
30-
* Checkout process
31-
* Animated mobile menu
32-
* Basic Playwright test(s) integrated with Github actions
19+
- Nuxt 3 for server-side rendering and optimal performance
20+
- Vue 3 and Composition API with <script setup> syntax
21+
- Tailwind CSS for responsive and customizable design
22+
- Nuxt Apollo for efficient GraphQL integration
23+
- Pinia with pinia-plugin-persistedstate for robust state management
24+
- Support for simple and variable WooCommerce products
25+
- Stock quantity management for all product types
26+
- CSS animations and transitions for enhanced user experience
27+
- Form handling and validation with Formkit, Vee Validate, and Yup
28+
- Streamlined checkout process
29+
- Animated mobile menu for improved mobile usability
30+
- Swiper integration for dynamic Hero section
31+
- Basic Playwright tests integrated with Github Actions
3332

3433
## Installation
3534

3635
1. Install and activate the following required plugins, in your WordPress plugin directory:
3736

38-
* [woocommerce](https://wordpress.org/plugins/woocommerce) Ecommerce for WordPress.
39-
* [wp-graphql](https://wordpress.org/plugins/wp-graphql) Exposes GraphQL for WordPress.
40-
* [wp-graphql-woocommerce](https://github.com/wp-graphql/wp-graphql-woocommerce) Adds WooCommerce functionality to a WPGraphQL schema. Currently only confirmed to be working with version 0.62 of this plugin.
41-
* [wp-algolia-woo-indexer](https://github.com/w3bdesign/wp-algolia-woo-indexer) WordPress plugin coded by me. Sends WooCommerce products to Algolia. Required for search to work.
37+
- [woocommerce](https://wordpress.org/plugins/woocommerce) Ecommerce for WordPress.
38+
- [wp-graphql](https://wordpress.org/plugins/wp-graphql) Exposes GraphQL for WordPress.
39+
- [wp-graphql-woocommerce](https://github.com/wp-graphql/wp-graphql-woocommerce) Adds WooCommerce functionality to a WPGraphQL schema. Currently only confirmed to be working with version 0.62 of this plugin.
40+
- [wp-algolia-woo-indexer](https://github.com/w3bdesign/wp-algolia-woo-indexer) WordPress plugin coded by me. Sends WooCommerce products to Algolia. Required for search to work.
4241

4342
Optional plugin:
4443

45-
* [headless-wordpress](https://github.com/w3bdesign/headless-wp) Disables the frontend so only the backend is accessible.
46-
* [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`
44+
- [headless-wordpress](https://github.com/w3bdesign/headless-wp) Disables the frontend so only the backend is accessible.
45+
- [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`
4746

4847
The current release has been tested and is confirmed working with the following plugin versions:
4948

50-
* WordPress version 6.6.2
51-
* WooCommerce version 7.4.0
52-
* WP GraphQL version 1.13.8
53-
* WooGraphQL version 0.12.0
54-
* WPGraphQL CORS version 2.1
49+
- WordPress version 6.6.2
50+
- WooCommerce version 7.4.0
51+
- WP GraphQL version 1.13.8
52+
- WooGraphQL version 0.12.0
53+
- WPGraphQL CORS version 2.1
5554

5655
2. Make sure WooCommerce has some products already or import some sample products
5756

0 commit comments

Comments
 (0)