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
| Task | Guide |
|---|---|
| Run your first App and save a record | Quickstart |
| Join an existing project or use Docker | Local and Docker development |
| Open or extend your sandbox | Open your Nexia workspace |
| Resolve setup, authentication, or runtime issues | Fix 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.
| Task | Guide |
|---|---|
| Add another App | Create an App Package |
| Generate a model, API, list, and form | Create a Resource |
| Add a stored field and apply its migration | Data Model and Migrations |
| Reference Core identities with foreign keys | Reference Core identities from App tables |
| Change a form, list, or standalone page | Build an App screen |
| Add an API with access checks | Add a protected API |
| Add a menu entry | Add a menu destination |
| Use settings and secrets | Add a settings page |
| Support multiple languages | Localize an App |
| Work with a coding agent | Build locally with AI |
| Choose how to integrate Apps | Choose a cross-App integration |
| Link another App's record | Reference another App record |
| Publish and consume an event | Events and asynchronous work |
| Show a Resource count on a dashboard | Add an App report |
| Create required installation defaults | Required installation content |
| Seed optional development data | Create development data |
| Background and scheduled work | Background and scheduled work |
| Import and export data | Import and export data |
| Receive INSERTs from an external PC or server | Receive external database writes |
| Run a business process | Run a business process |
| Connect Approval | Connect Approval |
| Provide Signature data | Provide Signature data |
| Place a profile widget | Place a profile widget |
| Board, Calendar and Schedule | Board, Calendar and Schedule |
| Search and commands | Search and commands |
| Notification availability | Notification availability |
| Report query limits | Report query limits |
Check and submit
- Test an App — check source and observe sandbox behavior.
- Troubleshoot App contribution discovery — diagnose missing menus, resources, or settings.
- Release an App — connect GitHub, submit a tag, and follow review results.
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 materialCommon Setup
Install the tools and connect your project and sandbox.
App Developers
Open your App folder and develop resources and screens.
Developer Tools
Find CLI commands for creating, running, and checking Apps.
19 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.
11 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.
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.
09 materials
Using the SDK
Use the PHP SDK and shared screen components in your App.
Open first materialSDK Overview
Choose an SDK capability by the task it supports.
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.
01 materials
Architecture
Understand the runtime choices, boundaries, tenancy, security, configuration, and extension model.
Open first materialTenancy and Security
Tenant and actor context plus the permission, role, and grant model.
Installation and Environment
Diagnose Docker, database, and initial configuration failures.
Discovery
Find why an App or contribution does not appear.
Business Process and E-Approval
Diagnose Business Process and E-Approval contract or runtime failures.