forked from opentiny/tiny-vue
docs: update README (#98)
This commit is contained in:
GitHub
parent
0a1a598a0e
commit
41f5809e66
|
|
@ -41,9 +41,9 @@ Local startup steps:
|
|||
- Click the Fork button in the upper right corner of the [TinyVue](https://github.com/opentiny/tiny-vue) code repository to Fork the upstream repository to the personal repository.
|
||||
- Clone personal repository to local.
|
||||
- Associated with the upstream repository to facilitate the synchronization of the latest code of the upstream repository.
|
||||
- Run `npm i --force` under the TinyVue root directory to install node dependencies.
|
||||
- Run `npm run dev:vue3` to launch the component library website.
|
||||
- Open the browser to visit: [http://127.0.0.1:5173/](http://127.0.0.1:5173/)
|
||||
- Run `pnpm i` under the TinyVue root directory to install node dependencies.
|
||||
- Run `pnpm dev` to launch the component library website.
|
||||
- Open the browser to visit: [http://127.0.0.1:6175/](http://127.0.0.1:6175/)
|
||||
|
||||
```shell
|
||||
# You need to replace username with your own user name
|
||||
|
|
@ -54,18 +54,18 @@ cd tiny-vue
|
|||
git remote add upstream git@github.com:opentiny/tiny-vue.git
|
||||
|
||||
# Installation
|
||||
npm i
|
||||
pnpm i
|
||||
|
||||
# Launch Vue.js 3
|
||||
npm run dev:vue3
|
||||
pnpm dev
|
||||
|
||||
# Launch Vue.js 2
|
||||
npm run dev:vue2
|
||||
pnpm dev:vue2
|
||||
```
|
||||
|
||||
To submit a PR:
|
||||
|
||||
- Make sure that you have completed the steps in local startup and can visit [http://127.0.0.1:5173/](http://127.0.0.1:5173/) normally.
|
||||
- Make sure that you have completed the steps in local startup and can visit [http://127.0.0.1:6175/](http://127.0.0.1:6175/) normally.
|
||||
- Synchronize upstream repository dev branch latest code: `git pull upstream dev`.
|
||||
- Create a new branch `git checkout-b username/feature1 upstream/ dev` from the upstream repository dev branch. The name of the branch should be `username/feat- xxx` / `username/fix- xxx`.
|
||||
- Local coding.
|
||||
|
|
|
|||
|
|
@ -41,9 +41,9 @@
|
|||
- 点击 [TinyVue](https://github.com/opentiny/tiny-vue) 代码仓库右上角的 Fork 按钮，将上游仓库 Fork 到个人仓库
|
||||
- Clone 个人仓库到本地
|
||||
- 关联上游仓库，方便同步上游仓库最新代码
|
||||
- 在 Tiny Vue 根目录下运行 `npm i --force`, 安装 node 依赖
|
||||
- 运行 npm run dev:vue3，启动组件库网站
|
||||
- 打开浏览器访问：[http://127.0.0.1:5173/](http://127.0.0.1:5173/)
|
||||
- 在 Tiny Vue 根目录下运行 `pnpm i`, 安装 node 依赖
|
||||
- 运行 `pnpm dev`，启动组件库网站
|
||||
- 打开浏览器访问：[http://127.0.0.1:6175/](http://127.0.0.1:6175/)
|
||||
|
||||
```shell
|
||||
# username 为用户名，执行前请替换
|
||||
|
|
@ -54,18 +54,18 @@ cd tiny-vue
|
|||
git remote add upstream git@github.com:opentiny/tiny-vue.git
|
||||
|
||||
# 安装依赖
|
||||
npm i
|
||||
pnpm i
|
||||
|
||||
# 启动 Vue3 项目
|
||||
npm run dev:vue3
|
||||
pnpm dev
|
||||
|
||||
# 启动 Vue2 项目
|
||||
npm run dev:vue2
|
||||
pnpm dev:vue2
|
||||
```
|
||||
|
||||
提交 PR 的步骤：
|
||||
|
||||
- 请确保你已经完成本地启动中的步骤，并能正常访问：[http://127.0.0.1:5173/](http://127.0.0.1:5173/)
|
||||
- 请确保你已经完成本地启动中的步骤，并能正常访问：[http://127.0.0.1:6175/](http://127.0.0.1:6175/)
|
||||
- 同步上游仓库 dev 分支最新代码：git pull upstream dev
|
||||
- 从上游仓库 dev 分支创建新分支 `git checkout -b username/feature1 upstream/dev`，分支名字建议为 `username/feat-xxx` / `username/fix-xxx`
|
||||
- 本地编码
|
||||
|
|
|
|||
|
|
@ -53,16 +53,16 @@ import { Button as TinyButton } from '@opentiny/vue'
|
|||
```shell
|
||||
git clone git@github.com:opentiny/tiny-vue.git
|
||||
cd tiny-vue
|
||||
npm i --legacy-peer-deps
|
||||
pnpm i
|
||||
|
||||
# Vue.js 3
|
||||
npm run dev:vue3
|
||||
pnpm dev
|
||||
|
||||
# Vue.js 2
|
||||
npm run dev:vue2
|
||||
pnpm dev:vue2
|
||||
```
|
||||
|
||||
Open your browser and visit: [http://127.0.0.1:5173/](http://127.0.0.1:5173/)
|
||||
Open your browser and visit: [http://127.0.0.1:6175/](http://127.0.0.1:6175/)
|
||||
|
||||
## 🤝 Contributing
|
||||
|
||||
|
|
|
|||
|
|
@ -53,16 +53,16 @@ import { Button as TinyButton } from '@opentiny/vue'
|
|||
```shell
|
||||
git clone git@github.com:opentiny/tiny-vue.git
|
||||
cd tiny-vue
|
||||
npm i --legacy-peer-deps
|
||||
pnpm i
|
||||
|
||||
# 启动 Vue3 项目
|
||||
npm run dev:vue3
|
||||
pnpm dev
|
||||
|
||||
# 启动 Vue2 项目
|
||||
npm run dev:vue2
|
||||
pnpm dev:vue2
|
||||
```
|
||||
|
||||
打开浏览器访问：[http://127.0.0.1:5173/](http://127.0.0.1:5173/)
|
||||
打开浏览器访问：[http://127.0.0.1:6175/](http://127.0.0.1:6175/)
|
||||
|
||||
## 🤝 参与贡献
|
||||
|
||||
|
|
|
|||
|
|
@ -41,9 +41,9 @@
|
|||
"preinstall": "npx only-allow pnpm",
|
||||
"postinstall": "pnpm build:internals",
|
||||
"bootstrap": "pnpm --filter=\"!./packages/dist/**\" install",
|
||||
"dev": "pnpm -C examples/vue3 dev",
|
||||
"dev:vue2": "pnpm -C examples/vue2 dev",
|
||||
"dev:vue2.7": "pnpm -C examples/vue2.7 dev",
|
||||
"dev:vue3": "pnpm -C examples/vue3 dev",
|
||||
"dev:docs": "pnpm -C examples/docs docs:dev",
|
||||
"build:entry": "pnpm -C internals/cli build:entry",
|
||||
"create:ui": "pnpm -C internals/cli create:ui",
|
||||
|
|
|
|||
Loading…
Reference in New Issue