Merge pull request #83 from LOG1997/feature-docs

文档更新

.github/CONTRIBUTING.md

@@ -0,0 +1,64 @@
+# 怎么为本项目做贡献
+
+你好！很高兴你为本项目做贡献。在提交您的贡献时，请务必阅读以下指南：
+
+## PR检查表
+
+- 该项目主要的工作分支有`main`和`dev`
+  - 请尽量从`main`分支拉取代码，该分支为稳定代码
+  - 你的代码提交（添加新功能、修复bug、优化性能等）需要发起PR到`dev`分支
+  - 请尽可能地在您的PR请求中描述清楚添加的功能或者修复的问题
+  - 在一个PR中有多个小提交是没问题的，但请确保每个提交都包含一个清晰的提交信息。
+  - 请确保您的提交信息遵循[Conventional Commits](https://www.conventionalcommits.org/)规范。
+
+## 开发设置
+
+推荐使用`pnpm`来进行包的管理。
+
+克隆仓库后，运行：
+
+```bash
+pnpm install  # 安装依赖
+```
+
+## 运行脚本
+
+### `pnpm dev`
+启动开发服务器
+```bash
+pnpm dev
+```
+
+### `pnpm build`
+构建项目
+```bash
+pnpm build
+```
+
+### `pnpm build:file`
+打包后的项目可以直接通过html文件的形式直接在浏览器打开
+```bash
+pnpm build:file
+```
+
+### `pnpm lint:fix`
+修复eslint格式错误
+```bash
+pnpm lint:fix
+```
+
+## 项目结构
+
+src目录下基本放置了所有的代码文件，其中最主要的是
+- `views`：存放页面代码
+- `components`：存放组件代码
+- `utils`：存放工具函数
+- `layout`: 页面布局
+- `locales`: 国际化
+- `router`: 路由配置
+- `store`: 状态管理
+- `types`: 类型定义
+
+## 感谢
+
+感谢您为本项目做出贡献

README.md

@@ -15,12 +15,9 @@
 
 log-lottery是一个可配置可定制化的抽奖应用，炫酷3D球体，可用于年会抽奖等活动，支持奖品、人员、界面、图片音乐配置。
 
-> 因原域名到期，现将原域名 (<https://24years.top/log-lottery>)
-迁移到 (<https://1kw20.fun/log-lottery>) 。
-
 > 如果进入网站遇到图片无法显示或有报错的情况，请先到【全局配置】-【界面配置】菜单中点击【重置所有数据】按钮清除数据后进行更新。
 
-> 请尽量拉取代码进行构建部署，本线上网站代码会保持更新，可能影响原有功能和数据。
+> 该项目将在近期进行**内部代码重构**及**开发新功能**，预计元旦节前三天上线新版本。
 
 ## 要求
 
@@ -28,7 +25,7 @@ log-lottery是一个可配置可定制化的抽奖应用，炫酷3D球体，可
 
 访问地址：
 
-<https://1kw20.fun/log-lottery>
+<https://to2026.xyz/log-lottery>
 
 or
 
@@ -134,14 +131,6 @@ or
 npm run build
 ```
 
-预览
-
-```bash
-pnpm preview
-or
-npm run preview
-```
-
 若想直接以打开html文件的方式运行，请执行以下命令进行打包。打包完成后在dist目录中直接打开index.html即可。
 
 ```bash