Installation#
We recommend using automatic installation to initialize your project, which will automatically complete all dependency installations for you.
If you need complete control over all installation details, or if you already have a project that you want to migrate to wis, we provide a Manual Installation guide.
Automatic Installation#
Create Project#
Execute the installation command:
$ npx @wisdesign/cli@latest create
✔ What's name of your project? my_app ✔ What cli do you want to use? rsbuild ✔ Could you want to use lint(default: Yes)? Yes ◆ Create Rsbuild Project │ ◇ Next steps ─────────────╮ │ │ │ 1. cd my_app │ │ 2. git init (optional) │ │ 3. npm install │ │ 4. npm run dev │ │ │ ├──────────────────────────╯ │ └ All set, happy coding!
At this point, we have created a project named my_app. If you have questions about the project structure, you can check the Project Structure section.
Install Dependencies#
You can use any package management tool to manage your project, such as npm, pnpm, yarn, etc.
$ cd my_app $ npm install
Start the Project#
Execute the start command:
$ npm run dev
Once the command is executed, you can simply visit http://localhost:3000 to see the project running.
Build the Project#
Execute the build command:
$ npm run build
Preview the Project#
Execute the preview command:
$ npm run build $ npm run preview
Manual Installation#
The manual installation method depends on which community scaffold you choose to use.