Slimmed-Down Version
Starting from version 5.0
, we no longer provide slimmed-down repositories or branches. Our goal is to offer a more consistent development experience while reducing maintenance costs. Here’s how we introduce our project, slim down, and remove unnecessary features.
Application Slimming
First, identify the version of the UI
component library you need, and then delete the corresponding applications. For example, if you choose to use Ant Design Vue
, you can delete the other applications. Simply remove the following two folders:
apps/web-ele
apps/web-native
TIP
If your project doesn’t include the UI
component library you need, you can delete all other applications and create your own new application as needed.
Demo Code Slimming
If you don’t need demo code, you can simply delete the playground
folder
Documentation Slimming
If you don’t need documentation, you can delete the docs
folder.
Remove Mock Service
If you don’t need the Mock
service, you can delete the apps/backend-mock
folder. Also, remove the VITE_NITRO_MOCK
variable from the .env.development
file in your application.
# Whether to enable Nitro Mock service, true to enable, false to disable
VITE_NITRO_MOCK=false
Installing Dependencies
Now that you’ve completed the slimming operations, you can install the dependencies and start your project:
# Run in the root directory
pnpm install
Adjusting Commands
After slimming down, you may need to adjust commands according to your project. In the package.json
file in the root directory, you can adjust the scripts
field and remove any commands you don’t need.
{
"scripts": {
"build:antd": "pnpm run build --filter=@vben/web-antd",
"build:docs": "pnpm run build --filter=@vben/docs",
"build:ele": "pnpm run build --filter=@vben/web-ele",
"build:naive": "pnpm run build --filter=@vben/web-naive",
"build:play": "pnpm run build --filter=@vben/playground",
"dev:antd": "pnpm -F @vben/web-antd run dev",
"dev:docs": "pnpm -F @vben/docs run dev",
"dev:ele": "pnpm -F @vben/web-ele run dev",
"dev:play": "pnpm -F @vben/playground run dev",
"dev:naive": "pnpm -F @vben/web-naive run dev"
}
}