WPCrudRest : A WordPress plugin creator (plugin code generator) tool

A Powerful Wordpress CRUD & RESTful plugin Generator framework

Introduction

This tool is the result of a master's thesis in MDSE research group at Isfahan University and contains a set of Eclipse plugins that enable you to generate a WordPress plugin by graphical modelling. We use a Model-Driven approach to generate codes from the model.
WPCrudRest framework is currently only available as a plugin for Eclipse. It used Sirius to provide a graphical modelling environment and Acceleo to transform models to code.

In short, the generated plugin has the following features:

Multilingual translation support (translatable with Loco Translate).
Support for left-to-right and right-to-left languages.
Automatic creation of required tables in the database.
Providing a web service to perform CRUD operations on defined entities.
Providing a web service to perform CRUD operations related to pages.
Provide custom web service structure.
Create defined menus and link them to the relevant pages.
Create entity list pages.
Create entity form page to create, display, or update an entity.
The possibility of managing the access control of web services users to perform CRUD operations on entities.
The ability to control the access control of management panel users to perform CRUD operations on entities.
The ability to manage access control for custom web services users.
Using Vue.js to create web user interfaces.
Ability to add more custom fields to the visual editor and plugin code.

WPCrudRest Demo

WPCrudRest Framework and created WordPress plugin demo:

Please participate in the evaluation

You can participate in the evaluation of the WPCrudRest framework through the following links:

Evaluation participate (English language)

‫

مشارکت در ارزیابی (فارسی)

Test environment:

This tool deployed and tested successfully on:

Guidance Videos

Download Eclipse modeling tools and Install (extract) it -> Watch video in: Youtube - Aparat
Download and deploy WPCrudRest as Eclipse plugin -> Watch video in: Youtube - Aparat
Install Acceleo as Eclipse plugin -> Youtube - Aparat
Start modeling (Create new modeling project) -> Youtube - Aparat
Model a simple library manager plugin (example) -> Youtube - Aparat
Deploy WordPress (on Windows OS) - Install XAMPP -> Youtube - Aparat
Deploy WordPress (on Windows OS) - Deploy (Install) WordPress -> Youtube - Aparat
Generate and deploy WordPress plugin -> Youtube - Aparat

You can also access full list of tutorial videos by this links:

Installation and use instructions:

You can follow the steps below to deploy and use the framework:

Note: You can follow this link to deploy WordPress on your personal computer if you are unfamiliar with WordPress!

A. Install Eclipse

Download Eclipse Modeling Tools
Install (unzip) downloaded Eclipse package

B. Configure Eclipse and Install required plugins

Download latest WPCrudRest package
Unzip downloaded package and copy dropins directory to eclipse installation path (e.g C:\Program Files\eclipse)
Execute Eclipse
Install Acceleo plugin
Install Sirius plugin if it is not installed (preinstall in newer versions)
Restart Eclipse

C. Create a new Modeling Project

Click on "File" menu item
Choose "New" ->" Other" item from "File" menu
In "Select a wizard" window, search for "Sirius" group and expand it by clicking
Choose "Modeling Project" and click "Next"
Select a name for project and type it in "Project name" field
Click on "Finish" button to create modeling project

D. Create "Crudrest Model"

Note: The field type repository model is used to define entities' field types and if dosn't exist, modelling and generating code is not possible! This is recommended to use exist pre-built field repository model!

Copy FieldTypeRepo.crudrest from models directory to project model (or root) directory
You can simply copy one of the sample models from the models repository directory and jump to the next step
Right click on project root in Eclipse Project (or Model) explorer
Choose "New" ->" Other" item from popup menu
In "Select a wizard" window, search for "Crudrest Model" an choose it
Click next and choose directory and a name (with .crudrest extension) to create model file and click "Next" button
Choose "Plugin Creator" from "Model Object" drop-down list
Click Finish to create model file

E. Open WordPress Crudrest Plugin Model in graphical editor

Double click on representations.aird file
Enable CrudRestWPP from Presentation part
Double click on CrudRestWPP to open Sirius visual model editor
Edit model
Save it!

F. Generate WordPress Plugin Code

If you want to deploy the plugin directly on your local WordPress, set WP_HOME path as Wordpress root directory in system environment
```
 Windows OS:
             setx WP_HOME WORDPRESS_PATH /M
 Example: 
             setx WP_HOME C:\xampp7.1\htdocs\projects\crudrest /M
```
Click here for more help
Right click on model
Choose "WP Crud-Rest" -> "Generate WordPress Plugin" from popup menu
Plugin code will be generated in "generated WPP" directory on project root directory