README.md

Rstack Examples

This repository contains comprehensive examples that demonstrate the Rstack ecosystem tools, including Rspack, Rsbuild, Rspress, and Rsdoctor. These examples showcase common implementation patterns and best practices to help developers leverage the full potential of the Rstack toolchain.

The main branch contains examples for Rspack/Rsbuild v2. For Rspack/Rsbuild 1.x examples, please check the v1.x branch.

List of Examples

Rspack		Examples	Document
Rsbuild		Examples	Document
Rspress		Examples	Document
Rsdoctor		Examples	Document
Rslib		Examples	Document

How to Use

Clone single example

To clone a single example, use giget to download a sub-directory from the current repository.

For example, to clone the /rspack/basic example, run the following command:

# Clone the basic example
npx giget gh:rstackjs/rstack-examples/rspack/basic my-app

# Enter the my-app example directory
cd my-app

# Install the dependencies
pnpm i

The second argument is the output directory. Pass it explicitly so the example is created with a clear local folder name.

You can clone any other example by replacing the path and output directory:

# Clone the Rsbuild React example
npx giget gh:rstackjs/rstack-examples/rsbuild/react my-app

# Clone the Rslib React example
npx giget gh:rstackjs/rstack-examples/rslib/react-basic my-lib

Clone all examples

To try all examples, you can clone the current repository to your local.

1. First, clone the current repository to your local:

git clone git@github.com:rstackjs/rstack-examples.git

2. Then, choose the example you need, such as the Rsbuild react example:

cd rsbuild/react

3. Install the dependencies using pnpm or other package manager, then start the project:

# Use corepack to enable pnpm
corepack enable
pnpm i
pnpm run dev

4. You can fork the current project or copy the code from the current project to use it.