Skip to content

Documentation

Nexia Docs

Build an App step by step, find a public SDK API, or look up the details behind your next task.

Build a PHP/React App locally and run it in a managed Nexia sandbox. Follow the Quickstart to save your first record.

The Console provides commands and runtime status at each step. Use these docs for implementation details and troubleshooting.

Get started

TaskGuide
Run your first App and save a recordQuickstart
Join an existing project or use DockerLocal and Docker development
Open or extend your sandboxOpen your Nexia workspace
Resolve setup, authentication, or runtime issuesFix CLI installation and connection errors

Build a feature

Already finished the quickstart? Keep your App and choose a task below. File paths are relative to the App folder.

TaskGuide
Add another AppCreate an App Package
Generate a model, API, list, and formCreate a Resource
Add a stored field and apply its migrationData Model and Migrations
Reference Core identities with foreign keysReference Core identities from App tables
Change a form, list, or standalone pageBuild an App screen
Add an API with access checksAdd a protected API
Add a menu entryAdd a menu destination
Use settings and secretsAdd a settings page
Support multiple languagesLocalize an App
Work with a coding agentBuild locally with AI
Choose how to integrate AppsChoose a cross-App integration
Link another App's recordReference another App record
Publish and consume an eventEvents and asynchronous work
Show a Resource count on a dashboardAdd an App report
Create required installation defaultsRequired installation content
Seed optional development dataCreate development data
Background and scheduled workBackground and scheduled work
Import and export dataImport and export data
Receive INSERTs from an external PC or serverReceive external database writes
Run a business processRun a business process
Connect ApprovalConnect Approval
Provide Signature dataProvide Signature data
Place a profile widgetPlace a profile widget
Board, Calendar and ScheduleBoard, Calendar and Schedule
Search and commandsSearch and commands
Notification availabilityNotification availability
Report query limitsReport query limits

Check and submit

Look up APIs and commands

Start using the SDK · Use the PHP SDK · Use the frontend SDK · Nexia CLI

Browse by section

Find the next thing you need to do.

07 materials

Getting Started

Connect your project, run an App in the sandbox, and find essential CLI commands.

Open first material

Common Setup

Install the tools and connect your project and sandbox.

02

App Developers

Open your App folder and develop resources and screens.

02

Developer Tools

Find CLI commands for creating, running, and checking Apps.

03

19 materials

Building Apps

Build, expose, secure, integrate, test, and release an independently versioned App.

Open first material

App Package

Decide whether a capability needs an independent App, then create it.

01

Domain and Data

Create Resources, data models, and migrations.

07

Protect an Operation

Apply SDK authorization contracts to policies, APIs, and tests.

01

Screens

Build and localize App screens with the Frontend SDK.

04

Cross-App Integration

Handle another App's facts and changes without direct dependencies.

04

Test and Release

Verify in the supported harness and release an independent version.

02

11 materials

Platform Integrations

Add menus, settings, widgets, and workflow integrations to your App as you need them.

Open first material

App Identity and Lifecycle

App identity, required installation content, and tenant-owned copies.

01

Shell and Navigation

Publish App Menu destinations and Command Palette behavior.

02

App Surface Extensions

Publish App settings screens, dashboard widgets, and slot widgets.

03

Resource Integration

Connect Resources through catalogs, references, and governed data movement.

02

Workbench Extensions

Publish App descriptors and business documents to Business Process, E-Approval, and Electronic Signature.

03

09 materials

Using the SDK

Use the PHP SDK and shared screen components in your App.

Open first material

SDK Overview

Choose an SDK capability by the task it supports.

01

PHP SDK

The PHP contracts an App may import.

02

Frontend SDK

The frontend contract between the Shell and App surfaces.

01

Contribution Contracts

Contracts that expose Resources and installation content.

02

Business Process, E-Approval, and Electronic Signature

Business Process, E-Approval, and Electronic Signature descriptor and host contracts.

03

01 materials

Architecture

Understand the runtime choices, boundaries, tenancy, security, configuration, and extension model.

Open first material

Tenancy and Security

Tenant and actor context plus the permission, role, and grant model.

01

03 materials

Troubleshooting

Find why an App, resource, or menu is missing.

Open first material

Installation and Environment

Diagnose Docker, database, and initial configuration failures.

01

Discovery

Find why an App or contribution does not appear.

01

Business Process and E-Approval

Diagnose Business Process and E-Approval contract or runtime failures.

01