---
title: "Getting Started with Unqork"
slug: "getting-started-with-unqork"
description: "Learn the fundamentals of building in Unqork by creating workspaces, applications, and modules while leveraging AI-assisted development for effective results."
tags: ["getting-started", "build-agent"]
updated: 2026-09-15T16:41:56Z
published: 2026-09-15T16:41:56Z
canonical: "docs.unqork.io/getting-started-with-unqork"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://docs.unqork.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Getting Started with Unqork

This guide walks new Creators through the fundamentals of building in Unqork. It covers creating a workspace, application, and module, then configuring components, connecting logic, and previewing the result. Understanding this process provides the context to build more effectively alongside the Build Agent.

While the Build Agent can generate entire modules from scratch, knowing how the pieces fit together enables more precise guidance, clearer review of what it builds, and more targeted changes when needed. The manual steps in this guide are the foundation for working confidently with AI-assisted development.

## Prerequisites

Before you begin, ensure you have the following:

- Access to an Unqork environment.
- An account with Creator permissions.
- A [supported web browser](/unqorkai/docs/supported-browsers). Supported browsers: Chrome, Edge, Firefox, and Safari.

For definitions of platform terms used in this guide, see [Platform Overview](/unqorkai/docs/platform-overview) and the [Glossary](/unqorkai/docs/glossary).

> Values are formatted as follows: `inline code` — a value to enter exactly as shown | **Bold** — a value selected from a drop-down, radio button, tab, or choice chip | **ON**/**OFF** — toggle state

## Step 1: Create a Workspace

Workspaces organize applications and modules. Use an existing workspace or create a new one:

1. From the main navigation, navigate to the [Workspaces Home Page](/unqorkai/docs/home).
2. If you are working in the Training Environment, a workspace has been created for you. Search for your workspace by entering your name in the search bar, then click it to open the workspace page and skip to Step 2.
3. Click **New Workspace**.
4. Enter a name that is unique in your environment. Use a descriptive name with your initials and today's date to keep it identifiable (for example: `Getting Started - CC - 20260602`).
5. Click **Create Workspace**.

You should now see your workspace in the list. Click your workspace to open the workspace page.

## Step 2: Create an Application

Applications are containers for modules, which are the screens and logic that make up an application.

1. From your workspace page, click **New Application**.
2. Enter a name that is unique in your environment. Use a descriptive name with your initials and today's date (for example: `Getting Started App - CC - 20260602`).
3. Verify the application is unique. The path is auto-generated from the name but must be unique in the environment.
4. Set the **Application Type** to **Module**. Module-based applications let you build user-facing screens, while Workflow applications are for backend automation.
5. Optionally, add a description: `My first Unqork application`.
6. Click **Create Application**.

The application page displays, where all the application's modules are managed.

An entrypoint module is automatically created with the application. It serves as the starting point for end-users.

## Step 3: Build a Module

Modules are the building blocks of an application. Each module represents a screen or workflow for end-user interaction.

### Open the Entrypoint Module

1. From the application page, locate the entrypoint module in the modules list.
2. Click the module to open the Module Builder.

The Module Builder opens. It displays the following:

- **Left panel**: The Build Agent panel.
- **Canvas**: The build area.
- **Right panel**: Component settings and the Explorer.

### Switch to Config View

By default, the module opens in UI View. In the header, click **Config View** in the View Toggler. The canvas switches to Config View, which lets you add and configure components.

### Add Components to the Canvas

Build a simple contact form by adding components:

1. In the component tray, search for the **Text Field** component or find it under **Primary Fields**.
2. From the component tray, drag the **Text Field** component onto the canvas.

The component displays on the canvas. The right panel displays its settings.

### Configure the Text Field Components

With the Text Field component selected:

1. In the **Property ID** field, enter `firstName`.
2. In the **Label Text** field, enter `First Name`.
3. In the **Validation** section, set **Required** to **ON**.

Repeat the process to add more fields:

| Component | Property ID | Label Text | Required |
| --- | --- | --- | --- |
| Text Field | `lastName` | Last Name | Yes |
| Email | `email` | Email Address | Yes |
| Text Area | `message` | Message | No |
| Button | `submitButton` | Submit | — |

### Save

In the header, click **Save**. A confirmation message displays in the header.

## Step 4: Preview Your Module

Test your module using Express View, the preview environment that displays how end-users experience your module.

### Option 1: Preview in a New Tab

In the header, click **View in App**. A new tab opens with your module in Express View. Fill out the form fields you created. Required fields display validation when empty.

To continue editing, return to the Module Builder tab.

### Option 2: Preview in UI View

1. In the header, switch to **UI View** using the View Toggler.
2. Click the **Select** button to deactivate it.
3. Interact with the components on the canvas.

Fill out the form fields you created. Required fields display validation when empty.

**Success!** The module is built and previewed.

## Step 5: Build with the Build Agent (Optional)

The Build Agent can build and modify modules using natural language. The Build Agent panel is available in the left panel by default. Try building a component with AI:

1. In the Build Agent panel, enter this prompt: `Add a drop-down for country selection with options for United States, Canada, and United Kingdom`.
2. Click **Send** or press **Enter**.

The agent creates a plan that shows what it will build. Review the plan, then complete the following steps:

1. In the Build Agent panel, click **Build Plan** to approve the plan.
2. The agent adds the Dropdown component to your canvas and saves the changes automatically.
3. Switch to **UI View** using the View Toggler in the header to see the result.
4. On the canvas, click the new Dropdown component to open the component settings.
5. Click **Select** and interact with the Dropdown component to see the country options.

The Build Agent can also do the following:

- Generate entire forms from descriptions.
- Connect components with logic.
- Create data transformations.
- Suggest accessibility improvements.

For more information, see [Getting Started with the Build Agent](/unqorkai/docs/getting-started-with-the-build-agent).

## Troubleshooting

### Cannot Create a Workspace

If you are in the Training Environment, you cannot create new workspaces. A workspace has already been created for you with your name. Use the search bar to find your workspace.

If you are not in the Training Environment and **New Workspace** returns an error, check your Creator permissions. You need Creator access to create workspaces. Contact your Unqork administrator to verify your role. See [Creator (User) Administration](/unqorkai/docs/creator-user-administration) for details on user roles.

### Module Changes Do Not Save

Ensure you've clicked **Save** in the header after making changes. If the save fails, check the following:

- Your network connection is stable.
- You have edit permissions for the module.
- The module is not locked by another Creator.

### Express View Displays an Error

If Express View displays an error, check the following:

- Ensure you have saved the module.
- Check that all required fields have valid Property IDs.
- Ensure there are no duplicate Property IDs in the module.
- Review any logic configurations for issues.

For more help, see [Troubleshooting Basics and Strategies](/unqorkai/docs/troubleshooting-basics-and-strategies).

## Next Steps

Now that you've built your first module, explore these topics next:

### Learn About the Module Builder

- [Module Builder Overview](/unqorkai/docs/module-builder-overview)
- [Component Reference](/unqorkai/docs/component-reference)
- [Component General Settings](/unqorkai/docs/component-general-settings)

### Connect Data and Logic

- [Data Workflow Component](/unqorkai/docs/data-workflow-component)
- [Decisions Component](/unqorkai/docs/decisions-component)
- [Working with Data](/unqorkai/docs/working-with-data)

### Build Workflows

- [Workflow Builder](/unqorkai/docs/workflow-builder-1)
- [Service Types](/unqorkai/docs/service-types)

### Organize and Deploy

- [Application Lifecycle](/unqorkai/docs/application-lifecycle)
- [Application Promotions](/unqorkai/docs/application-promotions)

### Collaborate and Manage Access

- [Understanding Designer RBAC](/unqorkai/docs/designer-rbac-overview)
- [Workspace-Level RBAC](/unqorkai/docs/workspace-level-rbac)

---

**Changelog**

| Date | Change |
| --- | --- |
| 2026-09-15 | Removed Terminology section (now links to Platform Overview and Glossary); fixed panel layout; corrected Build Agent step flow; removed stale Knowledge Nuggets reference (EN-8116). |
| 2026-06-02 | Full editorial pass: structure, terminology, step formatting, location-first rule, Unqork Terminology section, Supported Browsers link, AI-first framing, new overview paragraph. |
| 2026-05-26 | Initial publication. |

Also known as Unqork Users, or Designer Users; is anyone who is inside the Unqork platform.

Also known as Unqork Users, or Designer Users; is anyone who is inside the Unqork platform.

End-users, also known as Express Users, are the individuals accessing an application through Express View. In most cases, end-users are the customers using the product.

End-users, also known as Express Users, are the individuals accessing an application through Express View. In most cases, end-users are the customers using the product.

The UI (user interface) is a device's end-user interaction and communication point. It can include display screens, keyboards, and mouse. It is also how a user interacts with your application.

Express View is how your end-user views your application. Express View also lets you preview your applications to test your configuration and view the styling. This is also the view your end-users will see when interacting with your application. After configuring a module, click Preview in the Module Builder to interact with the module in Express View.

The Unqork front-end application framework that delivers Creator-built applications to end-users. Express is the layer end-users interact with—the published forms, screens, and navigation built in the Module Builder. Express is distinct from Express View, which is a Creator-facing preview tool in the IDE.

A Property ID is the unique field ID used by Unqork to track and link components in your module.