Why React and WordPress
WordPress and React are a killer combination to develop web apps.
With WordPress you get:
- easy content management for help pages, your landing page, your blog, and your other marketing activities
- secure and proven user management
- over 100.000 plugins
- a lot of flexibility over time to change the character of your site
React brings you the largest ecosystem to build great rich JavaScript apps that allow a simple data model, good performance and are easy to test.
For example, if we want to write a new revolutionary email app, we can write the interface of the email client with React, but for everything else use WordPress. So while you’re developing your app, you might want to:
- choose and install a theme
- create a landing page for your app
- add a form to collect email addresses
- create a blog and publish your posts on Twitter to promote your app
- optimize your site for search engines
Later it might be useful to
- offer a paid membership
- create a forum or FAQ
- create separate landing pages
- all this can easily be done with WordPress, without writing a single line of code.
Embedding a React app into WordPress with ReactPress
While there are other ways to integrate React with WordPress, the ReactPress plugin is the easiest to embed a React app into a WordPress page and lets you use create-react-app without any custom build configurations.
Not only does ReactPress automate the React integration for you, but it also ensures a seamless development experience, through running your local React dev server with the theme of your WordPress site.
Why not just using headless WordPress with SSR
I know that headless WordPress with Next.js, Gatsby, or Frontity is all the rage right now, but with these solutions, you add a layer of complexity to your app, and more importantly, you lose a lot of the benefits of the WordPress ecosystem (themes and plugins).
The steps from development to deployment are:
- Setup your local dev environment.
- Install ReactPress on your local WordPress installation
- Create a new React app from your WP installation
- Create a new React app
- Use create-react-app from the command line (recommended)
- Create a new React app from your local WP admin
- Develop your React app
- Build the app
- Install ReactPress on live WordPress site
- Create the same React app there
- Upload the build of your React app to your live site to deploy it.
Repeat steps 3, 4 and 7 until your app is finished.
Setup your local dev environment.
To develop React apps your WordPress installations needs access to:
- the PHP function
shell_execandexec - and a POSIX compatible system
Optionally, to create React apps directly from the WordPress admin it needs also:
- the
nodejspackage managernpmversion 6 or higher
This means you can’t create React apps from the WordPress admin if you use Local by Flywheel, but you can create your app from the command line with npx create-react-app my-app.
For Windows users we recommend using WSL-2.
Install ReactPress on your local WordPress installation
In your local WordPress go to plugin installation, search for ReactPress, install and activate the plugin.
Create a new React app
There are 2 ways to create a new react app with ReactPress. You can use the command line or you can use the admin page of ReactPress.
We recommend using the command line because you more control and feedback about what is going and you can use WordPress development environments like Local without worrying about npm access of your WordPress instance.
Creating a React app from the WordPress admin is now deprecated and only present for legacy reasons.
Use create-react-app from the command line (recommended)
To create a new app from the command line open a terminal and navigate to apps directory of the ReactPress plugin.
Use npx create-react-app [your-app-name] in the apps directory.
Then go to the ReactPress page in your WordPress admin. If you already opened the ReactPress page before, reload it.
You then will see the new app in the admin. Next, choose a URL Slug for your app. This will create a new page with the given slug. Make sure the slug you choose is not taken by any other page/post of your site.
Go back to your console, start the React app with npm start or yarn start. Your React app should be running with the styles of your WordPress site.
Create a new React app from your local WP admin
In the admin of your WP installation, click on ReactPress in the sidebar. There you should see a form to create a new React app.
Enter a name (later you need to use the same name in the live system), enter a pageslug, choose the type “Develop a new app (Usually on a local machine).” and choose the create-react-app-template you would like to use and finally click the “Create React App” button.
After a short while your app should be created and running at port: 3000. If you click on the link you can see your local dev app running in the theme of your WP installation.
Develop your React app
Now you can develop your React app as you are used to. Use WordPress’s built-in REST-API to get data or use the WPGraphQL plugin if you prefer GraphQL.
Build the app
If you want to deploy to your live site, build your app from the command line or through the WP admin – if your system fulfills the requirments.
Again, we recommend using the command line, because you have access to error messages.
Install ReactPress on live WordPress site
Before you upload your React app, install ReactPress on your live site the same way you did on your local installation.
Create the same React app there
Create the same React app on your live system, that you created on your local system. Important! Use the exact same name and this time choose “Deploy an already build app (Usually on a server).” as the type.
Upload the build of your React app to your live site to deploy it.
Finally, upload the build of your React app. Upload the build folder of your local React app to the app on your live system.
The ReactPress admin shows where your apps are located. It will be something like this: .../htdocs/wp-content/plugins/reactpress/apps/[your-appname].
If you click on the URL slug of your React app in ReactPress you should see your React app on your live system.
Where to go from here?
You should be able to create React app embedded in WordPress now. If you have the next big app idea you are ready to start.
If you have any questions, let me know in the comments.
Hi dear, great contribution! Im trying to use it to edit a react js file thought WordPress, would this work? I could not go further because the Virtual Maschine is not able to run properly, so I will try to install in another PC.
What do you mean with editing a reactjs file? You can use ReactPress to add whole React projects to your WordPress site.
Thanks for the tutorial (and the plugin!). One question: is it possible to use this to create a React component that can be rendered within the existing WP-generated DOM? For example, to use React to generate a form that appears in a page (for example by defining a shortcode that will output the necessary JS)? Or is this approach only useful if React handles the whole interface?
Thanks!
The plugin embeds the React app into the DOM of the WP instance. It creates a page were it renders the React app. If would like to use your React app in a different content type, you would need to delete the created page, create the content you would like and use the same slug as the deleted page had. Then you would need to insert some custom html into that content.
Long story short: It works, but it is cumbersome. You can add a React app only to one piece of content. You can’t reuse it.
New to WordPress. It sounds like I have to run WordPress locally? Is my WordPress plugins folder located on my machine? I’ve never heard of that. I just sign into the admin page and do things there.
Hey Dan,
yes you need a local WordPress installation. In that installation there is a pluginfolder in which you will develop your React app.
thank you !
can my webapp use data and interaction from custom field/custom post/metabox of my wordpress ?
for example : let’s just say i have already a wordpress blog recipe
and a webapp where users can add recipe in a calendar!
question:
can i dev a webapp that will enable user to add recipe from my blog wordpress to the app calendar ?
@Fred Yes, it can. You need to use the WordPress REST-api or the GraphQL interface provided by the WPGraphQL-plugin.
But this is nothing special from the plugin. You as the app developer are responsible to communicate with your backend. The only thing ReactPress provides directly attached to the
window-object is the user information atwindow.reactPress.Could I use this approach to create a Slider for my Home Site? So it would end up as a plugin/block or inside a theme which i get by shortcode.
Hi Michael, I doubt that this is the easiest approach to create an image slider for WP. You can however embed your React app into your home page, if you show a static page on your home page. Shortcodes are not supported, you have to embed your React app into the main content of a page.
What an amazing concept. I wish I could get it to work. typically I develop on windows and deploy to linux. I cannot get it to work on windows. when going to the app I get the following :
Warning: include(C:laragonwwwtaraseasonalswp-contentpluginsreactpress/templates/react-page-template.php): failed to open stream: No such file or directory in C:\laragon\www\taraseasonals\wp-includes\template-loader.php on line 106
It’s hard for me to debug your dev environment. Even more on Windows. Did you try to use Local by Flywheel as dev environment? In my tests, it worked fine, even on a virtual machine with Windows.
Hi, I tried to get this working, but when I go to the live server it fails to load the pages in because it loads: https://example.combuild/static/css/main.9d5b29c0.chunk.css and is missing the intermediate path to find the actual values.
windows not important. the production rollout will be on linux.
I just created a ubuntu 20.04 VM with apached, mysql. installed wordpress on the root and installed build version of my-react-app on the same apache2 instance on a different port. both wordpress and my-react-app are working as expected.
1) installed reactpress on wordpress
2) created a reactPress app type=”Deploy an already build app”
3) copied the content in my-react-app/build to the reactpress /apps folder.
4) set slug for React App
When I browse wordpress/my-react-app-slug, I get a 404 error:
Not Found
The requested URL was not found on this server.
Apache/2.4.41 (Ubuntu) Server at 192.168.1.46 Port 80
I feel I’m missing a step.
how can I debug this?
Hello ryan,
it seems your server root is not set. Please refer to this thread on how to fix this: https://wordpress.org/support/topic/issue-running-build-app/. Let me know if this helps.
Hello afshin,
it seems, that you didn’t build your react app with ReactPress inside an WordPress installation. This is mandatory, you need to add the pageslug first. React changes the configuration of your create-react-app.
It is mandatory that you build your app with ReactPress in WP site that matches the structure of your live site. Otherwise this will not work.
Please post further support question on https://wordpress.org/support/plugin/reactpress/
I tried it still 404 error.
just added the topic to the plugin support forum.
Images referred in my app from my public folder are no showing up. I tried to keep it in assets and import, then also they aren’t showing up on WordPress site. Although they work fine on localhost.
Any solution will be much appreciated.
Did you follow all the steps from the usage information in that exact order? https://wordpress.org/plugins/reactpress/
If yes, please open a forum topic in https://wordpress.org/support/plugin/reactpress/
Great article! Thanks for the tips.
I am looking to deploy to WordPress a react app I built with Create React App that is all finished up.
I didn’t start this project with React Press and I only have access to the clients’ admin panel.
Is it possible to achieve this?
Yes, this should be possible. But you have to rebuild the project locally first. The only difference is that you have to copy your React project to the apps folder instead of using create-react-app in the apps folder.
Install a local WordPress dev environment. I recommend Local (https://localwp.com/). Install ReactPress there.
To build your app follow these steps:
copy your project to [PATH_TO_PLUGINS]/plugins/reactpress/apps/
Click on the slug in the WP-Admin and your built app should be there.
Great concept! As I feel, here we are using two environment:
1. frontend as reactjs
2. backend as wordpress
But, one thing is making me confuse, wordpress is having its own routing and react is having its own. I am not sure that we can use react on wordpress as somewhat both are creating their own front-end. For example, if we talk about header part. The wordpress has its own header, which internally called into the php file. But if we want to use react component has header. I am not sure, how its going to work. The other thing is routing. react app use its own routing. So, we can use either one at a time.
But, here what I understood, we are using reactjs as a stand-alone application inside the wordpress eco-system using wordpress REST APIs. That is the great concept. Then again the question is why then both the apps into one eco-system. We can use wordpress installation as separate installation and use it only for the content management (as I usually does for react application as a backend for database). The react then can be used as a main application, which gets data from the wordpress REST API. Just a thought!!!
Hello Nishant,
For the first part:
You wouldn’t create a header in your React app if you don’t need it. You can choose different WP page templates where you insert your React app. Let’s say want to add a calculator to your site. You would just add it to a page, and there you have it: a calculator that is written with React.
But let’s look at a more complex example. Let’s say you want to recreate GMail with WordPress and React. You could use an empty page template for your React app, where you create your React app with a custom header. As for routing, let’s say you have your React app at /inbox. React router should work relative to the path of the WP page. From there your routing should work as normal, instead of /email/1 you would have /inbox/email/1.
Regarding your second question
The advantages of using React inside of WP instead of using a React SSR solution with WP as the headless CMS backend are:
Non-technical users can make changes to the site. Let’s say your marketing department wants to add an email newsletter. They install a plugin and that’s it. No need to change something in Next.js theme to reflect that.
Hope that clarifies things.
Just noticed your reply. Thanks so much! I’ll give that a shot for sure!
When you mention ‘install reactpress there.’ relating to localWP, do you mean opening the wordpress admin from inside local (by using that admin button on the top right) and installing the plugin that way? Or install the plugin before setting up local? or is there another way to install plugins through Local? sorry for all the questions, I have no idea about WP.
Hey there, disregard the last comment. I got it figured out! But it seems like styled components doesn’t work with the plugin 🙁 Thanks for all your help!
Doesn’t work in which way? Styled-components will only affect your React app not your WP site.