SolidX
Reference

Installation

Overview of how to initialize a SolidX project with `solidctl create-app`, with links to the full step-by-step tutorial.

Project Bootstrap

SolidX installation starts by bootstrapping a new project with solidctl create-app.

Mental Model

Installing SolidX is a project bootstrap step, not a library-install step.

  • create-app scaffolds a complete SolidX application workspace.
  • That workspace contains both solid-api and solid-ui.
  • You then build the project, seed metadata, and continue into development from there.

The key point is that SolidX creates a working project skeleton, not just a dependency added to an existing folder.

Bootstrap Flow

Run the command below to initialize your SolidX project:

solidctl create-app

Run solidctl create-app and supply the required project, database, and runtime configuration values.

The command scaffolds both solid-api backend and solid-ui frontend inside a single SolidX workspace.

After scaffolding, start the generated project, validate the admin UI and API surfaces, and then move into application-specific modeling and extension work.

Step-By-Step Tutorial

For complete step-by-step installation guidance, including environment setup and configuration, follow the dedicated tutorial:

Prerequisites

Describes the local tools required before installing SolidX and explains why they matter.

Project Structure

Describes the standard SolidX workspace layout across `solid-api`, `solid-ui`, and shared project files.

On this page

Project BootstrapBootstrap FlowStep-By-Step Tutorial