From a710b75162e41937ad73759f66d6026676513fa1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E7=A6=BB=E8=B0=B1?= <144224541+xixiIBN5100@users.noreply.github.com> Date: Wed, 2 Oct 2024 16:13:46 +0800 Subject: [PATCH] =?UTF-8?q?docs:=20=E4=BC=98=E5=8C=96=20README=20=E6=96=87?= =?UTF-8?q?=E4=BB=B6?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 54 +++++++++++++++++++++++++++++++++++++++--------------- 1 file changed, 39 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index 184a714..f4bfafb 100644 --- a/README.md +++ b/README.md @@ -1,30 +1,54 @@ -## 精弘网络问卷系统 +# 精弘网络问卷系统 + +使用Vue3 + TS + tailwindcss开发的问卷系统 + +## 介绍 + 这里是由浙江工业大学学生组织精弘网络完全独立自主开发的问卷系统的前端仓库,包含管理端和用户端. 在用户端做了较为完好的移动端适配,是调研工作中的好帮手. -### 技术栈 +## 技术栈 - Vue全家桶 -- typescript +- Typescript - tailwindcss +- Axios + +## 快速开始 -### 部署 -1. fork仓库 -2. clone自己fork的仓库到本地 -3. 修改vite代理到真正的后端地址 -4. 进入项目根目录,在命令行中运行 `pnpm i` -5. 安装完成后 `pnpm run dev` +1. fork仓库并clone到本地 +2. 切换至dev分支 +3. 依照`.env.sample`根目录配置`.env`文件 +4. 安装依赖 `pnpm i` +5. 运行 `pnpm run dev` 6. 点击本地运行网址进行预览 -### 贡献 +## 贡献 + 如果你在使用过程中发现bug或者想提出新的点子,欢迎提出issue,我们会定期查阅. -如果你想做出代码贡献,请按照以下步骤. +如果你想做出代码贡献,请按照以下步骤. + 1. fork仓库(不要main only) 2. clone仓库到本地 3. 切换至dev分支 4. 在本地dev分支上进行修改 -5. 运行`pnpm run lint`进行代码质量检测 -6. commit修改(务必按照commit message规范) -7. push至fork的仓库 -8. 提交pr至本仓库的dev分支(提交之前尽量确保commit历史不冗余) +5. Coding结束后运行`pnpm run lint`进行代码质量检测 +6. 提交修改 +7. pr至组织仓库的dev分支 + +## 打包部署 + +- `pnpm run build` 后将生成在根目录的dist压缩为压缩包发给后端小伙伴 + +## 更多资料 + +- tailwindcss 中文文档: [https://tailwind.docs.73zls.com/docs](https://tailwind.docs.73zls.com/docs) + +## 开发者 + +精弘问卷系统能走到今天，离不开这些开发者对前端的贡献❤️ + + + +