docs: update getting started document
This commit is contained in:
1 parent
212dea87dc
commit
55e373c2d7
1 file changed
+19
-3
+19
-3
@@ -2,15 +2,25 @@
|
||||
|
||||
## Clone project
|
||||
|
||||
You can easily clone a repository with just the npm command. (Recommend)
|
||||
### Method 1: `npm init` (Recommend)
|
||||
|
||||
You can easily clone a repository with just the npm command.
|
||||
|
||||
```shell
|
||||
$ npm init vutron
|
||||
```
|
||||
|
||||
OR, Click **[Use this template](https://github.com/jooy2/vutron/generate)** to instantly create your own project.
|
||||
The above method will not create unnecessary documentation and .github related files for your project.
|
||||
|
||||
OR, Clone this repo using below command.
|
||||
### Method 2: Use this template
|
||||
|
||||
Click **[Use this template](https://github.com/jooy2/vutron/generate)** to instantly create your own project.
|
||||
|
||||
This method creates a repository on GitHub immediately, but you will need to clone the project locally before you can use it.
|
||||
|
||||
### Method 3: Clone this repository
|
||||
|
||||
Clone this repo using below command. This method is suitable for direct contributions to the Vutron repository.
|
||||
|
||||
```shell
|
||||
$ git clone https://github.com/jooy2/vutron <PROJECT_NAME>
|
||||
@@ -33,6 +43,12 @@ $ pnpm i
|
||||
|
||||
## Run in development environment
|
||||
|
||||
Applications in the development environment run through **[Vite](https://vitejs.dev)**.
|
||||
|
||||
```shell
|
||||
$ npm run dev
|
||||
```
|
||||
|
||||
If your application doesn't appear after running command line commands, you may need to review if the default port is being used by another app.
|
||||
|
||||
Vite uses port `5173` by default.
|
||||
Reference in new issue
Block a user