diff --git a/README.en.md b/README.en.md deleted file mode 100644 index 0cd5ad8e359893a163418ed57dd7b71d54dd34ca..0000000000000000000000000000000000000000 --- a/README.en.md +++ /dev/null @@ -1,20 +0,0 @@ -# vue3-ts-starter - -### Description -vue3 starter - -### Software Architecture -Vue 3 + TypeScript + Vite + Scss + Vue Router + Pinia + Axios - -### Installation - -1. recommend using [pnpm](https://pnpm.io/installation),you can also use ```npm```、```yarn``` -2. install: ```pnpm install``` -3. run project: ```pnpm dev``` - -### Contribution - -1. Fork the repository -2. Create Feat_xxx branch -3. Commit your code -4. Create Pull Request \ No newline at end of file diff --git a/README.md b/README.md index 67f23d9f7d002d0d656da7db7c312c83352bedf5..fb9d319fda1fdc1ae0de55adf7606763a537c97f 100644 --- a/README.md +++ b/README.md @@ -1,48 +1,22 @@ -# vue3-ts-starter +# 开源社区贡献面板 -### 介绍 -vue3模板库, 使用vite构建,并集成Scss + Vue Router + Pinia + Axios +## 介绍 -### 软件架构 -Vue 3 + TypeScript + Vite + Scss + Vue Router + Pinia + Axios - -### 安装教程 -1. 推荐使用[pnpm](https://pnpm.io/installation)安装,当前你也可以使用npm、yarn -2. 安装依赖 ```pnpm install``` -3. 运行项目 ```pnpm dev``` - - -### 风格命名 -1. 文件夹名称建议使用kebab-case, 如: hello-world -2. vue文件建议使用PascalCase, 如: HelloWorld.vue +vue3 模板库, 使用 vite 构建,并集成 Scss + Vue Router + Pinia + Axios -### 目录说明 -``` -|-- src +## 软件架构 - |-- api API接口 - - |-- assets 资源目录,如图片、视频等 - |-- svg-icons svg 雪碧图图标 - - |-- components 跨页面公共组件 - - |-- pages 项目页面 - |-- course 页面 - |-- course-detail 子页面 +Vue 3 + TypeScript + Vite + Scss + Vue Router + Pinia + Axios - |-- shared 公共工具及文件 - |-- axios axios封装 - |-- styles 公共样式 +## 安装教程 - |-- stores 全局状态管理 +1. 推荐使用[pnpm](https://pnpm.io/installation)安装,当前你也可以使用 npm、yarn +2. 安装依赖 `pnpm install` +3. 运行项目 `pnpm dev` - --- main.ts 入口文件 - --- router.ts 路由文件 -``` +## 参与贡献 -### 参与贡献 -1. Fork 本仓库 -2. 新建 Feat_xxx 分支 -3. 提交代码 -4. 新建 Pull Request \ No newline at end of file +1. Fork 本仓库 +2. 新建 Feat_xxx 分支 +3. 提交代码 +4. 新建 Pull Request