96 lines
2.1 KiB
Markdown
96 lines
2.1 KiB
Markdown
|
---
|
||
|
|
outline: deep
|
||
|
|
---
|
||
|
|
|
||
|
|
# Quick Start {#quick-start}
|
||
|
|
|
||
|
|
## Prerequisites
|
||
|
|
|
||
|
|
::: info Environment Requirements
|
||
|
|
|
||
|
|
Before starting the project, ensure that your environment meets the following requirements:
|
||
|
|
|
||
|
|
- [Node.js](https://nodejs.org/en) version 20 or above. It is recommended to use [fnm](https://github.com/Schniz/fnm) or [nvm](https://github.com/nvm-sh/nvm) for version management.
|
||
|
|
- [Git](https://git-scm.com/) any version.
|
||
|
|
|
||
|
|
To verify if your environment meets the above requirements, you can check the versions using the following commands:
|
||
|
|
|
||
|
|
```bash
|
||
|
|
# Ensure the correct node LTS version is displayed
|
||
|
|
node -v
|
||
|
|
# Ensure the correct git version is displayed
|
||
|
|
git -v
|
||
|
|
```
|
||
|
|
|
||
|
|
:::
|
||
|
|
|
||
|
|
## Starting the Project
|
||
|
|
|
||
|
|
### Obtain the Source Code
|
||
|
|
|
||
|
|
::: code-group
|
||
|
|
|
||
|
|
```bash [GitHub]
|
||
|
|
# Clone the code
|
||
|
|
git clone https://github.com/vbenjs/vue-vben-admin.git
|
||
|
|
```
|
||
|
|
|
||
|
|
```bash [Gitee]
|
||
|
|
# Clone the code
|
||
|
|
# The Gitee repository may not have the latest code
|
||
|
|
git clone https://gitee.com/annsion/vue-vben-admin.git
|
||
|
|
```
|
||
|
|
|
||
|
|
:::
|
||
|
|
|
||
|
|
::: danger Caution
|
||
|
|
|
||
|
|
Ensure that the directory where you store the code and all its parent directories do not contain Chinese, Korean, Japanese characters, or spaces, as this may cause errors when installing dependencies and starting the project.
|
||
|
|
|
||
|
|
:::
|
||
|
|
|
||
|
|
### Install Dependencies
|
||
|
|
|
||
|
|
Open a terminal in your code directory and execute the following commands:
|
||
|
|
|
||
|
|
```bash
|
||
|
|
# Enter the project directory
|
||
|
|
cd vue-vben-admin
|
||
|
|
|
||
|
|
# Enable the project-specified version of pnpm
|
||
|
|
corepack enable
|
||
|
|
|
||
|
|
# Install dependencies
|
||
|
|
pnpm install
|
||
|
|
```
|
||
|
|
|
||
|
|
::: tip Note
|
||
|
|
|
||
|
|
The project only supports using `pnpm` for installing dependencies. By default, `corepack` will be used to install the specified version of `pnpm`.
|
||
|
|
|
||
|
|
:::
|
||
|
|
|
||
|
|
### Run the Project
|
||
|
|
|
||
|
|
Execute the following command to run the project:
|
||
|
|
|
||
|
|
```bash
|
||
|
|
# Start the project
|
||
|
|
pnpm dev
|
||
|
|
```
|
||
|
|
|
||
|
|
You will see an output similar to the following, allowing you to select the project you want to run:
|
||
|
|
|
||
|
|
```bash
|
||
|
|
│
|
||
|
|
◆ Select the app you need to run [dev]:
|
||
|
|
│ ● @vben/web-antd
|
||
|
|
│ ○ @vben/web-ele
|
||
|
|
│ ○ @vben/web-naive
|
||
|
|
│ ○ @vben/docs
|
||
|
|
│ ○ @vben/playground
|
||
|
|
└
|
||
|
|
```
|
||
|
|
|
||
|
|
Now, you can visit `http://localhost:5555` in your browser to view the project.
|