Skip to content

Latest commit

 

History

History
58 lines (44 loc) · 3.51 KB

README.md

File metadata and controls

58 lines (44 loc) · 3.51 KB
Raw

About Xe Theme

Issues Release Latest Downloads Repo Size License

Just a starter WordPress theme + build process. It is built for developers to create awesome and highly customizable themes for clients or sell it on any marketplace.

Download Latest Release Explore Documentation »

Requirements

Latest version of WordPress and Nodejs.

Getting Started

  1. Change folder name to your theme 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 theme 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.
  6. Run npm run child to generate child-theme in build destination folder.

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

Features

  • Theme Options (Customizer).
  • Highly Customizable and Easy to Customize.
  • Bootstrap 4 and Fontawesome 5 Icons.
  • Wide, Fluid and Boxed Layout.
  • Right, Left or Both Sides Sidebar Supported.
  • WooCommerce Ready.
  • One Click Demo Import.
  • Compatible with Elementor and WPBakery Page Builder.
  • Forever Free.

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.