Setup

Installation

A dependable six-step workflow for installing, running, building, and deploying Vexui.

Extract the package.
Unzip the purchased archive to a local workspace.
Open the project folder.
Open the folder containing package.json.
Install dependencies.
Run npm ci with the included lockfile from the project root.
Start local development.
Run npm run dev.
Create a production build.
Run npm run build.
Preview or deploy.
Use npm run preview locally, then deploy the generated production output according to your hosting platform.

npm install
npm run dev
npm run build
npm run preview

ImportantRun commands from the directory that contains package.json. Do not edit generated build output as a source of truth.

Additional scripts

Command	Purpose
`npm run build:dev`	Creates a build using development mode.
`npm run lint`	Runs the project ESLint command.
`npm run format`	Formats files with Prettier.
`npm run docs:build`	Updates both standalone documentation copies.
`npm run docs:check`	Checks documentation links and consistency.
`npm run test:direction`	Checks saved LTR/RTL settings behavior.

Cloudflare integration

Confirm the generated Worker entry, assets directory, and Cloudflare configuration emitted by the installed Nitro version.
Configure environment bindings and secrets in your deployment environment when you add backend integrations. No production AI, payment, hospital, or HR service is configured by these demo pages.
Serve the generated public assets, including /documentation/, alongside the app.
Test deep links, legacy redirects, SSR error behavior, dark mode, and RTL after deployment.

Generate both documentation copies

Run npm run docs:build after editing the documentation sources. This updates all guides in vexui-documentation/ and public/documentation/ together. Run npm run docs:check before distributing the standalone folder or building the app.