Skip to main content

Projects

Projects are the main workspace inside Buildocs UI Engine.

Think of a project as the container for everything related to one application, product, client, or environment.

If you are building a SaaS platform, you might create one project per product.
If you work with multiple clients, you might create one project per client.

Projects help you organize forms, control access, manage API keys, and keep environments separated.


What is a Project?

A project contains everything needed to render and manage your UI definitions.

This includes:

  • one or more forms and interface schemas
  • API keys for SDK authentication
  • theme configurations and UI styling
  • translations and localization settings
  • team member access and permissions
  • project-level settings

You can think of it as the root configuration layer for your Buildocs UI Engine setup.

Everything starts inside a project.


Why Projects Matter

Projects help you keep different systems separated and easier to manage.

For example:

  • production vs staging environments
  • different customers or tenants
  • internal tools vs client-facing applications
  • separate business units inside one company

Instead of mixing everything together, projects create clean boundaries.

This improves security, maintainability, and deployment workflows.


Creating a Project

Creating a new project only takes a few steps.

Step 1 — Log in

Open the Buildocs UI Engine dashboard and sign in to your account.

Step 2 — Click New Project

From the main dashboard, create a new project.

Step 3 — Add Basic Information

Enter:

  • project name
  • optional description

Choose a clear name that helps your team understand the purpose of the project.

Good examples:

  • Customer Portal
  • Internal ERP
  • Construction CRM
  • Client A Production
  • Client A Staging

Avoid generic names like “Test Project” if the project will be used long-term.


API Keys

Each project has its own API keys.

These keys are used by the SDK to securely fetch and render your interface definitions inside your application.

This means:

  • your frontend connects to a specific project
  • forms are loaded from the correct environment
  • access stays isolated between projects

For example, your staging application should use staging project keys, while production should use production keys.

This keeps environments safe and predictable.


Team Access

Projects support team collaboration.

You can invite team members and control who has access to a specific project.

This is useful when:

  • developers need SDK access
  • designers manage interface definitions
  • project managers review workflows
  • clients need limited access to their own project

Keeping access project-based helps avoid accidental changes across unrelated systems.


Project Transfer

Projects can be transferred to another account.

This is especially useful for agencies, consultants, and teams working with external clients.

Common use cases

  • handing off a completed project to a client
  • moving projects between internal team accounts
  • transferring ownership during company changes
  • separating personal and business ownership

For example, you might initially build a project under your own account and later transfer ownership to the customer.


How to Transfer a Project

To transfer a project:

  1. Open the project settings
  2. Select the Transfer Project option
  3. Enter the receiving account details
  4. Confirm the transfer request

The receiving account must accept the transfer before ownership changes.

Until accepted, the project remains under the current owner.

This helps prevent accidental transfers.


Best Practices

A few recommendations for keeping projects clean and scalable:

Use clear naming

Projects should be easy to identify without guessing.

Separate staging and production

Do not use one project for both environments.

Keep ownership intentional

Avoid building client projects under personal accounts long-term.

Limit access where needed

Only give project access to people who actually need it.

This improves security and reduces mistakes.


Summary

Projects are the foundation of Buildocs UI Engine.

They define where your forms live, how your SDK connects, who has access, and how environments stay organized.

A well-structured project setup makes everything else easier:

  • cleaner deployments
  • safer production releases
  • better collaboration
  • simpler client handoffs
  • more predictable architecture

Start with good project structure early — it saves a lot of pain later.