ClientX Docs

Quick start

This path gets ClientX running with the fewest steps: fetch the core source → create a resource → build → preview. For the full installation options and architecture, see Install.

1. Prerequisites

2. Fetch the core source

Download clientx-core-source.tar.gz from the downloads page, then extract it and install dependencies:

tar xzf clientx-core-source.tar.gz
cd clientx/
npm install

The extracted directory contains @clientx/runtime, @clientx/common, the CLI (scripts/clientx.mjs) and all builders.

3. Create your first resource

Use the CLI to generate a hello resource skeleton that depends on client (the app shell):

node scripts/clientx.mjs create hello --deps client

The generated structure:

src/resource/hello/
├── package.json     # @me/hello + clientx config
├── register.ts      # declareHello() + activateHello()
└── i18n/
    ├── zh.json
    └── en.json

4. Build

node scripts/clientx.mjs build --resources hello,client

The output is written to dist/, including core-app, shared-vendor, resource bundles and manifest.json.

5. Preview locally

npx serve dist
# or
python3 -m http.server --directory dist 3007

Open the URL printed by the server.

Next steps