Home
Projects
Download
Support
Sponsors
Sponsor Benefits
Buy Gifts
Donate Now
Join Us
Open Cooperation
Contribute
Contributors (26)
Events (1)
Academy
Outsourcing
Contact Us
Outsourcing
Open Cooperation
Sponsor
Others
Recruitment
Ask Us
Chat With Us
About Us
Back to project ezyplatform

Set Up an EzyPlatform Development Environment

Updated at 1787839092000

Overview

This post covers the development environment you should prepare before building EzyPlatform plugins or themes. It gathers the common setup steps in one reusable place so other plugin guides can point here instead of repeating the same instructions.
After finishing this setup, your machine should have:
  1. A local EzyPlatform server running against MySQL.
  2. The EzyPlatform SDK available from the command line.
  3. IntelliJ IDEA ready to import and run plugin projects.

Prerequisites

Before you start, make sure your machine has:
  1. JDK 8 (EzyPlatform currently runs on JDK 8).
  2. MySQL as the database.
  3. Apache Maven to build the project.
  4. IntelliJ IDEA (the Community edition is enough).

Install EzyPlatform (without Docker)

First, you need a local EzyPlatform server for your plugin to be installed into and tested against.
Main things to do:
  1. Install JDK 8 and set the JAVA_HOME environment variable, then verify with java -version.
  2. Install MySQL.
  3. Download the EzyPlatform package and extract it.
  4. Open settings/setup.properties and fill in your MySQL connection details.
  5. Run bash cli.sh "console admin" (Linux/MacOS) or .cli.bat "console admin" (Windows). Once you see EZYHTTP READY, the admin server has started successfully.
  6. Go to http://localhost:9090/setup-admin to create your first super admin account.
It's also a good idea to set an `EZYPLATFORM_HOME` environment variable pointing to your installation folder. This makes later SDK and plugin development steps easier to manage.
Detailed guide: Install EzyPlatform

Install the EzyPlatform SDK

The EzyPlatform SDK provides the ezy.sh/ezy.bat command-line tool, which lets you scaffold plugin projects, export modules, link plugins, and more, instead of doing everything by hand.
Main things to do:
  1. Download the EzyPlatform SDK from ezyplatform.com and extract it, for example into app/ezyplatform-sdk.
  2. Set the EZYPLATFORM_SDK environment variable to point to that folder.
  3. Add $EZYPLATFORM_SDK/bin to your PATH so you can call ezy.sh/ezy.bat from anywhere.
  4. Clone the ezyplatform-development repository and run bash build.sh (or .build.bat on Windows) to build the shared libraries needed for plugin development.
Detailed guide: Install the EzyPlatform SDK

Install IntelliJ IDEA

Download and install IntelliJ IDEA if you don't already have it. The free Community edition at [github.com/jetbrains/intellij-community](https://github.com/jetbrains/intellij-community) works fine.
This is the IDE you will use to import Maven projects, run startup test classes, and work with plugin/theme source code during development.

What's next

Once the environment is ready, you can continue with the EzyPlatform Plugin Development Quickstart to create your first plugin, learn the generated project structure, and link other plugins when needed.

Table Of Contents