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
Uses the power of the **[WordPress REST API][wapi]** and **[Progressive Web Apps][pwa]** to form a portable app viewer for WordPress-based sites.
@@ -14,12 +14,12 @@ Uses the power of the **[WordPress REST API][wapi]** and **[Progressive Web Apps
14
14
15
15
For a site to work, it has to meet the following criteria:
16
16
17
-
- A **WordPress site** with the **WP-JSON API endpoint** visible.
18
-
- This is 'on' by default, but some security plugins suggest disabling it for 'security' reasons.
19
-
- The API is **not** behind a **strict CORS policy**.
20
-
- The WordPress site hasn't customised the default access policies.
21
-
- A typical custom config will be to require authentication for viewing endpoints, which this tool will not handle.
22
-
- The tool is built to handle these scenarios, but will degrade the experience.
17
+
-A **WordPress site** with the **WP-JSON API endpoint** visible.
18
+
- This is 'on' by default, but some security plugins suggest disabling it for 'security' reasons.
19
+
-The API is **not** behind a **strict CORS policy**.
20
+
-The WordPress site hasn't customised the default access policies.
21
+
- A typical custom config will be to require authentication for viewing endpoints, which this tool will not handle.
22
+
- The tool is built to handle these scenarios, but will degrade the experience.
23
23
24
24
> [!WARNING]
25
25
> While we will [sanitise the HTML response](https://www.npmjs.com/package/dompurify) from the source API, this tool will obtain and display HTML from the specified site. Please only **use this tool with websites you trust**!
@@ -40,8 +40,8 @@ For a site to work, it has to meet the following criteria:
40
40
This project requires NodeJS to develop, test and compile the code. The following will quickstart you.
41
41
42
42
```bash
43
-
npm install
44
-
npm start
43
+
npm ci
44
+
npm run serve
45
45
```
46
46
47
47
The API the system will communicate with is defined in the appropriate `.env`.
@@ -54,12 +54,6 @@ If you want to test the PWA functionality locally, you can add the following to
54
54
devOptions: { enabled:true },
55
55
```
56
56
57
-
## react-hooks/exhaustive-deps
58
-
59
-
This has been ignored on the UseEffect commands where the WP API is called. This is because once wp is added to the
60
-
dependency array, an infinite loop is triggered. I welcome thoughts and suggestions to fix this, but until then (and it
61
-
causing no foreseeable bugs), it has been disabled.
0 commit comments