Get up to speed quickly with a new Rspack based project.
Before getting started, you will need to install Node.js >= version 16, it is recommended to use the Node.js LTS version.
Check the current Node.js version with the following command:
If you do not have Node.js installed in current environment, or the installed version is too low, you can use nvm or fnm to install.
Here is an example of how to install via nvm:
Rsbuild is a high-performance build tool powered by Rspack and developed by the Rspack team. It provides a set of thoughtfully designed default build configs, offering an out-of-the-box development experience and can fully unleash the performance advantages of Rspack.
We recommend using Rsbuild to create new projects, simply run the following command:
For more information, refer to Rsbuild - Quick Start.
Rspack CLI is a tool comparable to Webpack CLI, offering the basic serve
and build
commands.
Rsbuild supports Node.js >= 16, but Rspack CLI requires Node.js version >= 18.12.0.
Run the following command to create an Rspack CLI project:
Then follow the prompts in your terminal.
create-rspack and create-rsbuild provides some CLI flags. By setting these CLI flags, you can skip the interactive selection steps and create the project with one command.
For example, to create a React project in the my-project
directory with one command:
We provide an online example based on Rsbuild. The example gives an intuitive feel for the build performance of Rspack and the development experience of Rsbuild:
Start by creating a project directory and generating an npm `package.json':
Then installing @rspack/core
and @rspack/cli
as dev dependencies:
Update your build scripts to use Rspack CLI:
See Configure Rspack to learn about how to configure Rspack.
If you need to migrate from an existing project to Rspack or Rsbuild, you can refer to the following guides:
There are already some Rspack-based toolchains in the community:
Visit awesome-rspack to discover more projects within the Rspack ecosystem.
Rspress is a static site generator based on Rspack. It provides a complete solution for building static sites and includes the following features:
Learn more about Rspress in the official documentation.
Modern.js Framework is a Rspack-based progressive React framework that provides a complete solution for building web applications. It supports nested routes, server-side rendering, and provides out-of-the-box CSS solutions such as styled components and Tailwind CSS.
Learn more about Modern.js in the official documentation.
The fastest way to get up to speed quickly and leverage Rspack and React in a production-ready setting is to use the dedicated Rspack Nx plugin. This gives you a pre-configured setup, integrating Rspack with React, TypeScript, ESLint, Jest, and Cypress for e2e testing.
Run the following command to set up a new Nx workspace with React and Rspack:
The pre-configured setup is already ready to work with Rspack, TypeScript, TSX and React. In addition it also comes with Jest and Cypress for testing and ESLint for linting.
Once created you can simply npm start
(or pnpm start
or yarn start
) to start the development server. You can also run npm run build
(or pnpm run build
or yarn run build
) to build the application for production and similarly run npm run test
(or pnpm run test
or yarn run test
) to run the unit tests.
You can learn more about Nx at https://nx.dev.