Skip to content
Guides

Development

Work on the framework locally before publishing packages.

Get the source

bash
git clone https://github.com/lexibase/rdx.git
cd rdx

The framework repository uses pnpm workspaces. Install the pnpm version declared in its packageManager field, then run these commands from the repository root:

pnpm install
pnpm dev

Use a Node.js version supported by the repository's engines field. The tested CI environments use Linux/Node 22 and Windows/Node 24.

What runs locally?

apps/web is the official documentation and development site. It consumes framework packages through workspace:*, not published npm copies.

Shared UI lives in packages/rdx-ui; content, configuration, MDX, and search logic live in packages/rdx-core. The Next adapter and creator are separate packages. The versioning plugin remains optional for generated projects.

The development coordinator rebuilds local packages and watches changes. Use one Ctrl+C to stop its processes in the same terminal.

Validate a change

pnpm check
pnpm test:release --install

The first command runs lint, type checks, documentation checks, builds, and tests. The second packs local packages, installs their archives into a disposable generated project, and checks production behavior without publishing to npm.

Use pnpm test:release --i18n for the multilingual archive matrix: a standalone project and a pnpm monorepo, with language setup, fallback, search, contribution links, versioned translations and production deployment. Combine --install --i18n to run both installation matrices from the same archives.

Use pnpm docs:check from the repository root to check the official site's live, published and archived content on its own. This uses the same checker as rdx check, with the official site's URL aliases.

Release test artifacts are retained for inspection under .rdx-package-smoke/; use the final path printed by the command.

Pull request checks

GitHub Actions runs the same checks on Ubuntu with Node.js 22 and Windows with Node.js 24 for pull requests and pushes to main. Each runner installs the pnpm version in packageManager and uses the frozen workspace lockfile. It runs pnpm check and pnpm test:release --install --i18n. Dependency and build caches are separate for each environment.

The archive tests validate generated projects with pnpm. The installation guide also shows the supported npm and Yarn commands for creating and running a project.

bash
gh pr checks --watch
gh run list --workflow ci.yml --limit 5
gh run view <run-id> --log-failed

Documentation editions

Canary is the live documentation in apps/web/docs/. To save a documentation snapshot for a release, run:

pnpm --filter web docs:version 1.0.0

Do not run this on every commit or deployment. Subsequent work continues in Canary while the released snapshot remains unchanged.

Manage the official site's snapshots with the same versioning plugin:

pnpm --filter web docs:archive 1.0.0
pnpm --filter web docs:unarchive 1.0.0

Archiving and restoring change the manifest while preserving snapshot contents.

Contribution scope

Keep the foundation Next.js + Tailwind CSS + shadcn/ui Base UI. Build shared improvements in the packages, then integrate them into the official website and generated projects. Preserve the approved minimal interface and validate accessibility as well as appearance.