README.md

About Xe Plugin

Xe Plugin is a starter WordPress plugin which have built-in functionalities that are used in almost every plugin. So just focus on the main functionality that you want to built for WordPress.

Requirements

Latest version of WordPress and Nodejs.

Getting Started

1. Change folder name to your plugin name. e.g: xurais or xu-rais.
2. Navigate to node_scripts folder and open config.json with your favorite editor.
   • Change "name" to your plugin name eg: Xurais or Xu Rais.
   • Change "global" to a unique prefix. e.g: xurais or xus.
   • Change "build" to your desired folder path.
3. Open command line, navigate to project folder and run npm install to install dependencies.
4. Run npm run init command to change text-domain, prefixes, DocBlocks etc.
5. Run npm run build command to generate a clean copy in destination folder.

Note: .pot file will also be generated inside languages folder.

Contributing

🖥️ Hello, fellow developer! 🙂

Your pull requests will be highly welcomed. If you're looking for something to start with, you can check the issues or open one about something you want to contribute and we can discuss it before your pull request.

1. You must have latest version of WordPress and Nodejs.
2. Create a fork of this repository.
3. Clone the fork on your local machine. Your remote repo on Github is called origin.
4. Add the original repository as a remote called upstream.
5. If you created your fork a while ago be sure to pull upstream changes into your local repository.
6. Open command line, navigate to the local repository and run npm install to install dependencies.
7. Create a new branch to work on. Keep in mind that code should meet the WordPress Coding Standards.
8. Once changes/feature/fix is completed, push your branch to your fork on Github, the remote origin.
9. From your fork open a pull request in the correct branch. Target this project's main branch.