This project contains a WordPress Plugin that once installed and activated, transforms the WordPress front-end into a fully fledged Progressive Web App.
- nodejs v12.x (or use node version manager)
- docker
- Clone the repository
- Bootstrap the project with
npm install - Start the WordPress dev environment with
npm run wp-env start - Make sure the composer dependencies for the plugin are installed
npm run composer-install
The development environment should now be available!
- Frontend: localhost:8888
- Backend: localhost:8888/wp-admin/
- Username:
admin - Password:
password
- Username:
Note: The default settings for permalinks should be set to /%postname%/ manually, otherwise the REST API endpoint might not work, needs to be automated for the dev env.
It's currently located at localhost:8888/app/, after building it with npm run build.
For the floorplan to work, you need a mapbox token (see .env). Ask @vdwijngaert.
The GMP PHP extension needs to be installed for the notifications, but it doesn't seem possible to do so by configuration yet using wp-env.
It can be enabled with npm run prepare-wp-env. In case of issues, try and execute the steps in bin/install-gmp-extension.sh manually.
The service worker script that handles push notifications and displays the actual notifications is injected when running npm build.
Push notification and subscribers can be managed from the WP Backend "tools > PWA" menu.
Updates can be managed in the WP backend, by adding new posts of type "Update".
This project was originally bootstrapped with Create React App.
In the project directory, you can run:
Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.
The page will reload if you make edits.
You will also see any lint errors in the console.
Launches the test runner in the interactive watch mode.
See the section about running tests for more information.
Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.
The build is minified and the filenames include the hashes.
Your app is ready to be deployed!
See the section about deployment for more information.
Note: this is a one-way operation. Once you eject, you can’t go back!
If you aren’t satisfied with the build tool and configuration choices, you can eject at any time. This command will remove the single build dependency from your project.
Instead, it will copy all the configuration files and the transitive dependencies (Webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except eject will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.
You don’t have to ever use eject. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.
You can learn more in the Create React App documentation.
To learn React, check out the React documentation.
This section has moved here: https://facebook.github.io/create-react-app/docs/code-splitting
This section has moved here: https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size
This section has moved here: https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app
This section has moved here: https://facebook.github.io/create-react-app/docs/advanced-configuration
- Staging: https://staging.app.fri3d.be/wp-admin/
- Production: https://app.fri3d.be/wp-admin/
bash build.sh. Het script vraagt om welke omgeving, en zal dan een zip maken.
In WordPress vervolgens de bestaande plugin deactiveren. Dan de gemaakte zip uploaden op /wp-admin/plugin-install.php om zo de nieuwe versie te releasen.
This section has moved here: https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify