Skip to main content
Version: v11.14.0

Local Project Setup

Before developing a WMX Widget, you need to set up your project locally, so you can add the component directly into the WaveMaker project files. Once added, you can push your changes back to Studio and start using the new WMX Widget in your app.

1. Set Up the Project Locally​

  1. In WaveMaker Studio, go to: Settings → Export → Export Project as Sources (ZIP)
  1. Download and extract the ZIP file to your local system.
  2. Open the extracted folder in your preferred an Editor/IDE (e.g., Visual Studio Code).
  3. You can now create or edit WMX Widgets and make other custom modifications locally.

2. Enable Project Sync​

To push your local changes to Studio (and pull updates from Studio), you need to set up Project Sync.

Prerequisites​

Following software must be installed and configured on your system.

Initialize WaveMaker Workspace Sync​

  1. Open a terminal in your project’s root directory.
  2. Run:
    mvn wavemaker-workspace:init
  3. Press y when prompted.
  4. When prompted, provide:
    • WaveMaker Studio Host URL
    • Your login credentials using Email & Password or a Token (Token can be generated at https://<WaveMaker_Studio_Host>/studio/services/auth/token)
  5. When prompted, select the correct project number.
note
  • Host URL is the domain of your WaveMaker Studio.
  • You must keep your WaveMaker Studio session open until the sync completes.

3. Sync Commands​

  • Pull changes from Studio:
mvn wavemaker-workspace:pull
  • Push changes to Studio:
mvn wavemaker-workspace:push

Once your custom component is added, use the push command to upload it to Studio and start using it in your project.