Documentation
Nexia Docs
Build an App step by step, find a public SDK API, or look up the details behind your next task.
Start with the quickstart: create a developer project, prepare a cloud sandbox, connect the public CLI, and open your own app in a Nexia work tab. Core is private server software and is not distributed to developers.
Use AI-assisted development to iterate inside your app folder. The CLI alpha supports static app previews and review submission; SDK package references describe a separate integration contract and do not grant private repository access.
Build an App
Build your business feature as an App Package. The SDK supplies the public PHP and React APIs; Core runs your App with tenant context, authorization, and the product Shell. Start with one Resource and add the capabilities you need.
| Step | What you finish |
|---|---|
| Quickstart | A running local host and tenant login |
| Create an App Package | Your own package, identity, and entry point |
| Create a Resource | A Note model, protected API, and working screens |
| Data Model and Migrations | A field persisted and exposed through the Resource |
| Build an App screen | A usable form, detail view, and list |
| Test an App | Evidence that your changes and access rules work |
| Release an App | A versioned package a host can install and upgrade |
Each guide starts with the working path. Options and explanations follow it. If you already have a checkout, use Set up App development to select the App you will edit.
Find the feature you need
| I want to… | Start here |
|---|---|
| Understand how my App runs | Nexia System Overview |
| Find an SDK service, component, or hook | App SDK |
| Add or protect a business action | Add a protected API |
| Add search, filters, or a form field | Build an App screen |
| Publish navigation, a widget, or another capability | Extension Model |
| Reference another App's data or react to changes | Choose a cross-App integration |
| Add approval, a process, or signing | Business Process, Electronic Approval, Electronic Signature |
| Export or import Resource data | Resource Transfer |
| Diagnose a missing App or screen | Fix contribution discovery |
Understand the responsibilities
Your App owns business data, validation, policies, and screens. SDK contracts connect it to Core services and extension points. Core owns tenant isolation, host service implementations, and composition of the product UI.
Read Tenant and context and Permissions and roles before changing access or asynchronous work. Installation alone does not grant business permissions.
Advanced work
For host changes, development commands, or deployment settings:
- Core and SDK Development — change the host or SDK itself.
- Task commands — look up development commands.
- Environment Variables — configure a deployment or optional service.
Browse by section
Find the next thing you need to do.
08 materials
Getting Started
Run a local host, prepare your App checkout, and find development commands.
Open first materialCommon Setup
Install the host and prove repository access before choosing a work lane.
App Developers
Select the local App source used by the host.
Platform and SDK Developers
Prepare the cross-repository workflow for Platform, SDK, and App contracts.
Developer Tools
Find Task and Artisan commands by purpose and operational impact.
10 materials
Building Apps
Build, expose, secure, integrate, test, and release an independently versioned App.
Open first materialApp Package
Decide whether a capability needs an independent App, then create it.
Domain and Data
Create Resources, data models, and migrations.
Protect an Operation
Apply SDK authorization contracts to policies, APIs, and tests.
Screens
Build and localize App screens with the Frontend SDK.
Cross-App Integration
Handle another App's facts and changes without direct dependencies.
Test and Release
Verify in the supported harness and release an independent version.
17 materials
Platform Integrations
Add menus, settings, widgets, and workflow integrations to your App as you need them.
Open first materialApp Identity and Lifecycle
App identity, required installation content, and tenant-owned copies.
Shell and Navigation
Publish App Menu destinations and Command Palette behavior.
App Surface Extensions
Publish App settings screens, dashboard widgets, and slot widgets.
Authorization Extensions
Suggest App permission bundles through administrator-adopted role presets.
Resource Integration
Connect Resources through catalogs, references, and governed data movement.
Workbench Extensions
Publish App descriptors and business documents to Business Process, E-Approval, and Electronic Signature.
13 materials
SDK Reference
Find public PHP services, frontend components, and contribution contracts for your App.
Open first materialSDK Overview
Choose an SDK capability by the task it supports.
App Package
Composer metadata and App manifest contracts.
PHP SDK
The PHP contracts an App may import.
Frontend SDK
The frontend contract between the Shell and App surfaces.
Contribution Contracts
Contracts that expose Resources and installation content.
Business Process, E-Approval, and Electronic Signature
Business Process, E-Approval, and Electronic Signature descriptor and host contracts.
06 materials
Architecture
Understand the runtime choices, boundaries, tenancy, security, configuration, and extension model.
Open first materialWhole System
The runtime map joining browsers, agents, Central, tenants, and Apps.
Platform, SDK, and App Boundaries
The three ownership regions and allowed dependency directions.
Tenancy and Security
Tenant and actor context plus the permission, role, and grant model.
Extension Model
Contributions, catalogs, presets, templates, and descriptors.
Configuration Model
Separate deployment, platform, and App-owned configuration.
07 materials
Platform Runtime
Follow how the Platform discovers, combines, authorizes, and executes the contracts published by Apps.
Open first materialWeb and Shell
The tenant SPA and Shell runtime that compose routes, surfaces, and App contributions.
Backend Runtime
Laravel, Octane, FrankenPHP, and the lifecycle of long-running work.
Search Runtime
The execution boundary between candidate retrieval and tenant authorization checks.
Content
The Platform-owned Knowledge, Document Library, and Communications capabilities behind Information.
06 materials
Operations and ConfigurationOperators
Configure supported platform services and bring optional local runtimes online safely.
Open first materialPlatform Configuration
Choose and configure Site Configuration and Search runtime profiles.
Optional Services
Bring optional services such as Agent Gateway online for the work that needs them.
06 materials
Troubleshooting
Diagnose installation, discovery, boundary, tenant-context, and test failures.
Open first materialInstallation and Environment
Diagnose Docker, database, and initial configuration failures.
Discovery
Find why an App or contribution does not appear.
Boundaries
Repair Platform, SDK, and App import or ownership violations.
Context and Tests
Diagnose tenant, actor, and test-harness failures.
Business Process and E-Approval
Diagnose Business Process and E-Approval contract or runtime failures.