Recommended app
We recommend using the VS Code editor, but the choice is up to you.
It is also recommended to use tools to compile,compress and minify your javascript(.js) and style sheet(.css) files.
Tools such as the following are pretty good:
Sample
We also recommend you to start with this sample. Download and unzip the archive in the directory of your choice
Download sample code
Setting up the plugins
Once the code is in place, follow these few steps:
-
Change the directory name to your plugins name
Ex.: id3-plugin-sample id3-awesome-plugin
-
Rename the file named "id3-plugin-sample" to match the new directory name
This is Wordpress convention for plugins
-
Open the directory in VSCode and edit the file you just renamed
It's also a good time to save this workspace for VSCode
-
Follow the instruction in the file
Github
Once your project is properly setup, it's time to configure the Github repository.
In VSCode:
-
Select the Source Control tab (Ctrl+Shift+G)
-
Click the "Initialize Repository" button
-
Type "Initial commit" in the message box and then click the Commit button
In Github desktop:
-
Add the local repository
Open File menu, Add local repository... and select the plugins folder
-
Click the "Publish repository" button to create a remote version on Github
-
Give a name to the remote repository, keep the code private and select the Organization (id3tech)
The name of the remote repository should be capitalized and suffixed with "-Wordpress-Plugin". Ex.: Id3-Plugin-Sample-Wordpress-Plugin
-
Click the "Publish repository" button
Happy coding!