zet pack

Create your first extension

  1. Execute zet init [Refer to its usage here.]
    • You'll see a prompt where you have to choose a Zoho service for which you are creating an extension.
  2. Choose Zoho Projects
  3. Give a name for your extension. A folder structure will be created.
  4. Execute cd [extension name]
    • This command will set the current path to the newly created extension's directory path.
  5. Navigate to the above directory in your machine and develop your extension using client-side technologies like HTML, JS, CSS, etc.
    • Points to remember:
      Define the manifest reference clearly.
    • Include this JS in your code before calling the JS SDK methods supported by us.
  6. Execute zet run [Refer to its usage here.]
    • This command starts a local server and runs the extension locally.
    • Your extension will run on the port 5000. Ensure its availability before you execute this command.
  7. Hit http://127.0.0.1:5000/plugin-manifest.json or http://127.0.0.1:5000/app/index.html to confirm whether the server has started successfully. You can also test the extension in the developer mode before validating it.
  8. Execute zet validate [Refer to its usage here.]
    • This command checks whether the extension meets the guidelines defined in the plugin-manifest.json file. Learn how to configure your plugin-manifest.json file here.
    • A success message will be displayed in green if the file passes validation. In case of failure, make changes accordingly and execute zet validate again.
  9. Execute zet pack [Refer to its usage here.]
    • This command compresses the files and folders essential for running the extension and gives a ".zip" file as the output. The file will be present inside the path "/{extension's directory}/dist". 
      • Sample file path: "/myfirstextension/dist".
    • This zipped file should be submitted to ZApps irrespective of whether your extension is private or public.

Test extension in developer mode

Prerequisites

  • You must be logged into your Zoho Projects portal to test the extension in the developer mode. If you don’t have an account yet, sign up with us here and have an active session opened on your browser.

  • The extension should be running on the port 5000.

  1. Click  in the upper-right corner.
  2. Choose Developer Space under Integration and select Create Extension.
  3. Click Enable developer mode.
  4. The extension that’s running on the port 5000 will be rendered in all the predefined locations in Zoho Projects. You can navigate to the specified widget locations and test the extension.
  5. Only the extensions running on local will be rendered when developer mode is enabled and other extensions will be disabled.
  6. To exit from the developer mode, deselect the Enable developer mode button.
  • Installation is not needed to test the extension in developer mode. Hence the value parameter in the configuration should be provided along with the name in plugin-manifest.json file.
  • Do not authorize the connection once again since it was already done while creating plugin-manifest.json file.
  • The data of the extension running on local is not stored in Zoho Projects. Instead, it takes the local storage of the browser.
  • The extension that's running on the port 5000 will only be shown in the developer mode. 

Share this post : FacebookTwitter

Still can't find what you're looking for?

Write to us: support@zohoprojects.com