Skip to content

README.md

Latest commit

 

History

History
70 lines (42 loc) · 1.92 KB

README.md

File metadata and controls

70 lines (42 loc) · 1.92 KB

DX

Monorepo to hold tools made for DX ⚡

Packages

Check the documentation here.

Usage

To get started with any package, navigate to the respective package directory and follow the installation and usage instructions in its README.

Development

Requirements

To use this monorepo, you need to have the following tools installed:

  • Bun >= 1.2.4
  • pnpm >= 10.0.0
  • mise >= 2025.3.3 (optional)

Setup

  1. Clone the repository:

    git clone git@github.com:variableland/dx.git

  2. Install dependencies:

    pnpm install

  3. Run tests:

    pnpm test

Commands

This monorepo uses Turborepo to manage tasks. Here are some useful commands:

  • pnpm build - Build all packages
  • pnpm test - Run tests for all packages

Additionally, the monorepo itself uses the CLIs run-run and starter:

  • pnpm rr - Run the run-run CLI in development mode
  • pnpm vland - Run the starter CLI in development mode

If you have mise installed, you can use the following commands directly:

  • rr - Run the run-run CLI in development mode
  • vland - Run the starter CLI in development mode

Release

This monorepo uses Changesets to manage releases. The Changesets bot is also installed in the repository.

Preview Release:

To preview changes in any package, create a pull request using the branch pattern feat/* or fix/*. This triggers a special GitHub workflow that publishes the package with the changes to the npm registry under the tag pr-<PR_NUMBER>. To preview your changes, install the package with the corresponding tag:

pnpm add @vlandoss/<package>@pr-123