JavaScript Development Tips

By using the zep-script-SDK library, you can keep your folder structure neat and make the project compression process simpler than before. Let’s take a look at how to use the zep-script-SDK.

1. Install node.js

Visit to download and install node.js.

We recommend installing the LTS version, which is the most stable version.

2. Organize Project Folders

To use the library, the project folder should be organized as follows:

The res folder is where you put the images, sounds, and html files to be used in the app.

→ The folder name must be res.

3. Create a Project as a Zip File Using the CLI

Now when you deploy your app, you can use the CLI to create a project as a zip file with a command.

The CLI can be run from the terminal for MacOS, Windows PowerShell in windows, or the terminal environment provided since Windows 11.

Running PowerShell on Windows

Shift + right-click in the empty space of the folder in which main.js is located.

Choose Open PowerShell window here or Open command window here.

A Windows PowerShell or Command Prompt window will launch as follows:

Open a command window in the folder where the main.js file is located and enter the following command to create a compressed file.

npx zep-script archive

If the compression process was successful, you can check that a compressed file has been created in the folder as follows:

Finally, after creating the zip file, you’re ready to deploy your app.

4. Deploy a Project

1. Deploy on a website

You can deploy your app by uploading the zip file created above.

Refer to the ZEP Script Deployment Guide and distribute your app!

2. Deploy using CLI

You can deploy the zip file created by using CLI.

Create a zep-script.json file as below and set the app to upload. (Make sure not to change the file name.)

    "appId": "Zjkgoj",  // app ID
    "name": "Template", // app name
    "description": "Template application" , // app description
    "type": "normal" // app type ( "normal" or "minigame" or "sidebar" )

⭐ appID: Enter the ID of the app to upload.

  • To change an existing app, access, select an app to upload, and then enter the text appended to apps/ in the address bar. (E.g., "Zjkgoj" for the reference image below)

Open a command window in the folder where the main.js file is located and enter the following command to create a compressed file.

npx zep-script publish

Account verification is required during the app upload process.

When the email input section appears below, enter the email address of the account that owns the app to be deployed.

When you see the message saying, Sending login code to your email, go to the mailbox of the email you entered above. Check the verification code and enter it to the command window to start deploying.

The deploy process is complete when a green checkmark appears on the left of Publishing… as shown below.

You can see your app has been deployed in the My Apps page as described above in the zep-script.json file.

For more information about the library, please refer to the contents of the GitHub repository below. zep-script-sdk/packages/zep-script-cli at main · zep-us/zep-script-sdk

Last updated