-
Notifications
You must be signed in to change notification settings - Fork 6
/
README.txt
196 lines (121 loc) · 6.77 KB
/
README.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
=== ReactPress - Create React App for Wordpress ===
Contributors: rockiger
Tags: react, embed, developer, javascript, js
Requires at least: 5.0
Tested up to: 6.4.3
Requires PHP: 7.4
Stable tag: 3.2.2
License: GPLv2 or later
License URI: http://www.gnu.org/licenses/gpl-2.0.html
Easily create, build and deploy React apps into your existing WordPress sites.
== Description ==
ReactPress enables you to easily create, build and deploy React apps into your existing WordPress sites. Use your React knowledge to create single page applications for your WordPress customers.
Get started in seconds and develop your React app with instant feedback and your WordPress theme in mind.
Combine the flexibility of WordPress with the UI capabilities of React and seamlessly integrate create-react-app into your WordPress project for your next SaaS.
ReactPress does 3 things:
* It integrates your local dev server into your WordPress theme, that you have instant feedback, how your React app looks in the context of your WordPress website.
* It builds your React app in a way that it is usable from your WordPress site.
* It makes it easy to upload your app to a live server after building.
=== Features ===
* Fast refresh during app development
* WordPress integration during development
* Easy deploy to your live site
* client-side routing
* zero-config
* TypeScript support
=== Links ===
* [Website](https://rockiger.com/en/reactpress/)
* [Getting Started](https://rockiger.com/en/reactpress/getting-started/)
* [In depth React with WordPress Tutorial](https://rockiger.com/en/reactpress/reactpress-tutorial/)
* [FAQ](https://rockiger.com/en/reactpress/understanding-reactpress/)
* [Development](https://github.com/rockiger/reactpress/)
=== System Requirements ===
To develop React apps your WordPress instance needs access to:
* Access to the PHP function `file_get_contents`. Some hosting providers deactivate `fopen` on which `file_get_contents` depends. Access to `file_get_contents` is neccessary on your dev and your live system!
* POSIX compatible system, Windows support is experimental. ([Alternatively Windows users can use WSL2](https://rockiger.com/en/windows-survival-guide-to-for-react-and-web-developers/ "Windows Survival Guide for React and Web Developers"))
== Installation ==
1. Like any other plugin install via *Plugins/Add New*. You can download the plugin via admin or upload it to the plugins directory.
2. Activate the plugin through the 'Plugins' menu in WordPress
== Upgrade Notice ==
Release 3.0.0+ does change page information differently. Backward compatibility has to be broken for that. Downgrading won't work without reacreating pages.
Upgrades should be smoothless.
== Screenshots ==
1. Empty admin view.
2. The new React app is created.
3. The local React dev server is running on port: 3000. Every change will hot reload immediately.
4. The React app is deployed on the public server.
== Changelog ==
= 3.2.2 =
* Update the React dev environment even if the ReactPress app is on a private page. Thanks to @BlairCooper
* Improve compatibility with non-standard WordPress configurations like Bedrock. Thanks to @dylanlawrence
* Improve security
= 3.2.1 =
* Removing extra script tag when using vite - thanks to @dylanlawrence
* Using ABSPATH for the document root
= 3.2.0 =
* Support React apps with Vite (other kinds of frontend frameworks coming soon)
* (Very) basic support for more than one app on one page.
= 3.1.0 =
* Make sure that pages of all states (private, draft) are shown.
* Improve user feedback when something goes wrong during index.html update.
* Don't write empty content to index.html if page download did not work.
* Add css as late as possible to ReactPress page, to reduce `!important` in app's css.
* Add information about the post into `reactPress` variable
* Automatically update the app list without the need to reload the page
= 3.0.1 =
* Allow child pages to be ReactPress pages, where a React app is embedded.
* Add support for hosts that have turned the `php.ini` setting `allow_url_fopen` to `off`.
* Don't delete options when uninstalling plugin.
= 2.1.3 =
* Use relative file names for templates, to allow different folder configurations. Thanks to https://github.com/BlairCooper.
* Improve system requirements
= 2.1.2 =
* Don't show encrypted user password on frontend.
* Improve Windows compatibility
= 2.1.0 =
* Add totally empty canvas template. This template doesn't get any styles and scripts from WordPress. Good if you want to embed a totally independent React app.
* Add nonce and base rest_url to global ReactPress variable.
* Fix loading of global ReactPress variable.
* Improve Windows compatibility
* Securtiy fix: don't show encrypted user password
= 2.0.1 =
* Improve Windows compatibility
= 2.0.0 =
* Add an app to an existing page
* Make client-side routing optional, thus allowing child pages of a React app
* Improve documentation
* Use a React app in more than one page
* Revamp the admin page to be cleaner and a React app itself
* Add PHP namespaces
* Use create-react-app in the admin area for dogfooding
* Add post state label to signal the user a page was created by ReactPress
* Test with WordPress 6.0.2
= 1.3.2 =
* Swap file_get_contents for wp_remote_get.
* Create custom routing for react-router based on slug of the reactpress page.
* If the folder of an app is deleted, it is shown as type: Orphan
= 1.3.0 =
* Move apps directory to wp-content/reactpress/apps to don't mess with the created app when updating the plugin.
* Remove possibility to create new react apps from the admin. From now on there is only the command line workflow.
= 1.2.1 =
* FIX: Template incompatibility with Elementor and some other plugins. Thank to the great answer of Sally CJ https://stackoverflow.com/questions/67696139/error-in-wordpress-with-plugin-reactpress/68455647#answer-67751220
* FIX: Problems if document root and plugin app directory are on the same machine/server/locationn
= 1.2.0 =
* Revamp the process of adding using ReactPress. Don't start the react app anymore, only update the `index.html` from WordPress admin. Make it possible to add apps manually with npm or yarn.
* Add fallback if we can't find the plugin directory programmatically.
= 1.1.0 =
* Test with WordPress 5.7
* Insert the current user object to the global window object in Javascript, to have it accessible without a call to the API.
* add .env with CHOKIDAR_USEPOLLING=true to ensure watcher works with VM
* Use npm instead of yarn.
= 1.0.0 =
* Check for if it allows `shell_exec` and `exec`
* `npm -v >= 6.0.0` is reachable from WordPress
* Find out if we are in a Windows environment
* Deploy app to production
* Add TypeScript/template support
* Delete app
* Build app
* Extend index.html in React app to look like WordPress site
* Create new React app
* Add React app in specified page