Reference

Reference pages covering project structure, metadata, APIs, extension points, testing, and deployment in SolidX.

Developer Docs

Welcome to SolidX developer documentation. SolidX is an enterprise-focused, metadata-driven application platform engineered for modern web applications.

Mental model

The Reference section is best read as a map of the major layers inside a SolidX project.

Setup: prerequisites, installation, and project structure
Operations: CLI workflows, seeding, testing, and deployment
Platform definition: metadata schema and generated behaviour
Interfaces: REST APIs and frontend/backend extension points

This section serves as a technical reference map for how a SolidX application is bootstrapped, configured, generated, extended, and operated.

Project Foundations

Core references for bootstrapping a SolidX workspace and understanding how the project is organized.

Prerequisites

Establish the local toolchain required for SolidX development, including Node.js, PostgreSQL, Git, Python-based MCP/agent prerequisites, and supporting CLI utilities.

Installation

Bootstrap a new SolidX workspace with solidctl create-app and understand the initialization flow before moving into application-level work.

Project Structure

Review how solid-api, solid-ui, metadata, generated artifacts, and shared SolidX packages fit together within the application workspace.

solidctl Commands

Use the CLI as the operational control surface for project creation, build, seeding, generation, upgrades, testing, and platform maintenance.

SolidX Platform Reference Areas

Reference pages covering metadata, REST APIs, extension points, dashboards, testing, and production deployment.

Metadata Schema

Work with the metadata schema that defines models, fields, views, actions, menus, permissions, templates, and other generated platform behavior.

Extending SolidX

Extend the generated system through supported backend and frontend customization points rather than forking or bypassing framework conventions.

REST APIs

Review authentication, CRUD conventions, recovery semantics, and Swagger-backed API behavior across generated resources.

Dashboarding

Build metadata-driven dashboards, widget providers, and runtime-backed operational reporting surfaces.

Testing

Work with the metadata-driven testing system, including scenario authoring, API automation, UI automation, and test workflow orchestration.

Going Live

Prepare SolidX for production deployment across Docker, ECS, and VM-based hosting models with the associated operational considerations.