Code Builder

Introduction

The Code Builder allows app designers to create and reuse code snippets within a Joget app. This enhances maintainability and streamlines the development process. By using the Code Builder Hash Variable, you can retrieve these snippets easily across your application.

Plugin Information

• Enhance Maintainability: Any changes made to a code snippet will be automatically reflected wherever it's used in the app.
• Access Predefined Snippet Templates: Get started quickly with scripting using predefined code snippet templates.
• Code Editor Features: Enjoy code indentation and syntax highlighting through the built-in code editor.
• Advanced Tools: Utilize the Builder Advanced Tools to find all usages of a particular code snippet template.
• Customization: If required, you can create highly customized code snippet templates using plugins.

Get Started

Prerequisites

• Joget Version: DX 7 or DX 8

• OpenAI Account: Required to use Generative AI features.

Where to Get the Plugin

You can download this plugin from the Joget Marketplace.

How to Install

1. Navigate to the Joget Marketplace. Click Download on this plugin screen (It will be a .jar file)

2. Go to your Joget localhost or server.

3. In the Joget Console, navigate to Admin Bar > System Settings > Manage Plugins.

4. Click the Upload Plugins button.

5. Under Upload Plugin, select the .jar file you downloaded and click Upload.

How to Use It

1. In the App Composer page, click Add New under Code Builder.
   

2. Fill in the Code Snippet details and click Save.
3. Under Advanced Tools, click Code Assistant to configure the Code Snippet properties.   

Configure Code Snippet Builder Properties

Fields to Configure:

• Model: Choose the AI model you want to use (e.g., gpt-3.5-turbo).

• API Key: Enter the API Key obtained from the OpenAI platform.

• Debug: Show relevant debug in the server log for debugging purposes.

• Proxy Domain: Define the proxy domain for accessing the OpenAI API (e.g., https://api.openai.com).

Expected Outcome

After implementation, users will be able to:

• Scaffold code using templates.
  
• Generate code with AI assistance using natural language prompts using comments: /*<prompt>*/.
  

• Create and reuse modular code snippets across Joget elements
  

• The code snippets can be reused throughout your application using the Code Builder Hash Variable, along with the code snippet ID as the key.
  

Video Tutorial

Related Documentation

• Code Templates

• Code Snippet Properties

Download Plugin

Download the plugin from the Joget Marketplace.

Download Sample App