Skip to content

Commit 7a25b4f

Browse files
committed
TODO add login
1 parent 827952c commit 7a25b4f

File tree

1 file changed

+59
-60
lines changed

1 file changed

+59
-60
lines changed

README.md

Lines changed: 59 additions & 60 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,10 @@
22
[![Codacy Badge](https://api.codacy.com/project/badge/Grade/29de6847b01142e6a0183988fc3df46a)](https://app.codacy.com/gh/w3bdesign/nextjs-woocommerce?utm_source=github.com&utm_medium=referral&utm_content=w3bdesign/nextjs-woocommerce&utm_campaign=Badge_Grade_Settings)
33
[![CodeFactor](https://www.codefactor.io/repository/github/w3bdesign/nextjs-woocommerce/badge)](https://www.codefactor.io/repository/github/w3bdesign/nextjs-woocommerce)
44
[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=w3bdesign_nextjs-woocommerce&metric=alert_status)](https://sonarcloud.io/dashboard?id=w3bdesign_nextjs-woocommerce)
5-
6-
![bilde](https://github.com/user-attachments/assets/08047025-0950-472a-ae7d-932c7faee1db)
75

6+
![bilde](https://github.com/user-attachments/assets/08047025-0950-472a-ae7d-932c7faee1db)
87

9-
## Star History
8+
## Star History
109

1110
[![Star History Chart](https://api.star-history.com/svg?repos=w3bdesign/nextjs-woocommerce&type=Date)](https://star-history.com/#w3bdesign/nextjs-woocommerce&Date)
1211

@@ -16,33 +15,33 @@
1615

1716
## Table Of Contents (TOC)
1817

19-
- [Installation](#Installation)
20-
- [Features](#Features)
21-
- [Issues](#Issues)
22-
- [Troubleshooting](#Troubleshooting)
23-
- [TODO](#TODO)
24-
- [Future Improvements](SUGGESTIONS.md)
18+
- [Installation](#Installation)
19+
- [Features](#Features)
20+
- [Issues](#Issues)
21+
- [Troubleshooting](#Troubleshooting)
22+
- [TODO](#TODO)
23+
- [Future Improvements](SUGGESTIONS.md)
2524

2625
## Installation
2726

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

30-
- [woocommerce](https://wordpress.org/plugins/woocommerce) Ecommerce for WordPress.
31-
- [wp-graphql](https://wordpress.org/plugins/wp-graphql) Exposes GraphQL for WordPress.
32-
- [wp-graphql-woocommerce](https://github.com/wp-graphql/wp-graphql-woocommerce) Adds WooCommerce functionality to a WPGraphQL schema.
33-
- [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.
29+
- [woocommerce](https://wordpress.org/plugins/woocommerce) Ecommerce for WordPress.
30+
- [wp-graphql](https://wordpress.org/plugins/wp-graphql) Exposes GraphQL for WordPress.
31+
- [wp-graphql-woocommerce](https://github.com/wp-graphql/wp-graphql-woocommerce) Adds WooCommerce functionality to a WPGraphQL schema.
32+
- [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.
3433

3534
Optional plugin:
3635

37-
- [headless-wordpress](https://github.com/w3bdesign/headless-wp) Disables the frontend so only the backend is accessible. (optional)
36+
- [headless-wordpress](https://github.com/w3bdesign/headless-wp) Disables the frontend so only the backend is accessible. (optional)
3837

3938
The current release has been tested and is confirmed working with the following versions:
4039

41-
- WordPress version 6.6.2
42-
- WooCommerce version 7.4.0
43-
- WP GraphQL version 1.13.8
44-
- WooGraphQL version 0.12.0
45-
- WPGraphQL CORS version 2.1
40+
- WordPress version 6.6.2
41+
- WooCommerce version 7.4.0
42+
- WP GraphQL version 1.13.8
43+
- WooGraphQL version 0.12.0
44+
- WPGraphQL CORS version 2.1
4645

4746
2. For debugging and testing, install either:
4847

@@ -52,7 +51,6 @@ The current release has been tested and is confirmed working with the following
5251

5352
3. Make sure WooCommerce has some products already
5453

55-
5654
4. Clone or fork the repo and modify `.env.example` and rename it to `.env`
5755

5856
Then set the environment variables accordingly in Vercel or your preferred hosting solution.
@@ -73,36 +71,36 @@ The current release has been tested and is confirmed working with the following
7371

7472
## Features
7573

76-
- Next.js version 14.3.11
77-
- React version 18.3.1
78-
- Typescript
79-
- Tests with Playwright
80-
- Connect to Woocommerce GraphQL API and list name, price and display image for products
81-
- Support for simple products and variable products
82-
- Cart handling and checkout with WooCommerce (Cash On Delivery only for now)
83-
- Algolia search (requires [algolia-woo-indexer](https://github.com/w3bdesign/algolia-woo-indexer))
84-
- Meets WCAG accessibility standards where possible
85-
- Placeholder for products without images
86-
- Apollo Client with GraphQL
87-
- React Hook Form
88-
- Native HTML5 form validation
89-
- Animations with Framer motion, Styled components and Animate.css
90-
- Loading spinner created with Styled Components
91-
- Shows page load progress with Nprogress during navigation
92-
- Fully responsive design
93-
- Category and product listings
94-
- Show stock status
95-
- Pretty URLs with builtin Nextjs functionality
96-
- Tailwind 3 for styling
97-
- JSDoc comments
98-
- Product filtering:
99-
- Dynamic color filtering using Tailwind's color system
100-
- Mobile-optimized filter layout
101-
- Accessible form controls with ARIA labels
102-
- Price range slider
103-
- Size and color filters
104-
- Product type categorization
105-
- Sorting options (popularity, price, newest)
74+
- Next.js version 14.3.11
75+
- React version 18.3.1
76+
- Typescript
77+
- Tests with Playwright
78+
- Connect to Woocommerce GraphQL API and list name, price and display image for products
79+
- Support for simple products and variable products
80+
- Cart handling and checkout with WooCommerce (Cash On Delivery only for now)
81+
- Algolia search (requires [algolia-woo-indexer](https://github.com/w3bdesign/algolia-woo-indexer))
82+
- Meets WCAG accessibility standards where possible
83+
- Placeholder for products without images
84+
- Apollo Client with GraphQL
85+
- React Hook Form
86+
- Native HTML5 form validation
87+
- Animations with Framer motion, Styled components and Animate.css
88+
- Loading spinner created with Styled Components
89+
- Shows page load progress with Nprogress during navigation
90+
- Fully responsive design
91+
- Category and product listings
92+
- Show stock status
93+
- Pretty URLs with builtin Nextjs functionality
94+
- Tailwind 3 for styling
95+
- JSDoc comments
96+
- Product filtering:
97+
- Dynamic color filtering using Tailwind's color system
98+
- Mobile-optimized filter layout
99+
- Accessible form controls with ARIA labels
100+
- Price range slider
101+
- Size and color filters
102+
- Product type categorization
103+
- Sorting options (popularity, price, newest)
106104

107105
## Troubleshooting
108106

@@ -116,21 +114,22 @@ Check the attributes of the products. Right now the application requires Size an
116114

117115
## Issues
118116

119-
Overall the application is working as intended, but it has not been tested extensively in a production environment.
120-
More testing and debugging is required before deploying it in a production environment.
117+
Overall the application is working as intended, but it has not been tested extensively in a production environment.
118+
More testing and debugging is required before deploying it in a production environment.
121119

122120
With that said, keep the following in mind:
123121

124-
- Currently only simple products and variable products work without any issues. Other product types are not known to work.
125-
- Only Cash On Delivery (COD) is currently supported. More payment methods may be added later.
122+
- Currently only simple products and variable products work without any issues. Other product types are not known to work.
123+
- Only Cash On Delivery (COD) is currently supported. More payment methods may be added later.
126124

127125
This project is tested with BrowserStack.
128126

129127
## TODO
130128

131-
- Add total to cart/checkout page
132-
- Copy billing address to shipping address
133-
- Add order dashboard and require login
134-
- Hide products not in stock
135-
- Add better SEO
136-
- Re-add Next/image when it is working better
129+
- Implement UserRegistration.component.tsx in a registration page
130+
- Add user dashboard with order history
131+
- Add Cloudflare Turnstile on registration page
132+
- Add total to cart/checkout page
133+
- Copy billing address to shipping address
134+
- Hide products not in stock
135+
- Add better SEO

0 commit comments

Comments
 (0)