新增:文档体系重构+CHANGELOG补充+发布产物清理
This commit is contained in:
99
README.md
99
README.md
@@ -1,59 +1,74 @@
|
||||
# Welcome to Your New Wails3 Project!
|
||||
# U-Desk
|
||||
|
||||
Congratulations on generating your Wails3 application! This README will guide you through the next steps to get your project up and running.
|
||||
桌面文件管理器,基于 [Wails v3](https://v3.wails.io/) (Go + Vue 3)。
|
||||
|
||||
## Getting Started
|
||||
## 功能
|
||||
|
||||
1. Navigate to your project directory in the terminal.
|
||||
- 文件浏览 / 编辑 / 预览(文本、Markdown、图片、Office、PDF)
|
||||
- 收藏夹管理(折叠/展开、拖拽排序、置顶)
|
||||
- Markdown 编辑器(实时预览、语法高亮、Mermaid 图表)
|
||||
- 远程文件服务器连接
|
||||
- 主题切换(亮色/暗色)
|
||||
- 版本更新检查
|
||||
|
||||
2. To run your application in development mode, use the following command:
|
||||
## 技术栈
|
||||
|
||||
```
|
||||
wails3 dev
|
||||
```
|
||||
| 层 | 技术 |
|
||||
|---|------|
|
||||
| 桌面框架 | Wails v3 (alpha.80) |
|
||||
| 后端 | Go 1.22+ |
|
||||
| 前端 | Vue 3 + TypeScript |
|
||||
| UI 组件库 | Arco Design Vue |
|
||||
| 编辑器 | CodeMirror 6 |
|
||||
| 构建 | Vite 7 + Taskfile |
|
||||
|
||||
This will start your application and enable hot-reloading for both frontend and backend changes.
|
||||
## 项目结构
|
||||
|
||||
3. To build your application for production, use:
|
||||
```
|
||||
├── main.go # 入口:窗口配置、中间件、DevTools
|
||||
├── app.go # 应用逻辑:文件系统、更新检查等
|
||||
├── internal/ # 内部模块
|
||||
│ ├── filesystem/ # 文件操作、锁、预览服务
|
||||
│ └── api/ # API 处理器
|
||||
├── frontend/ # 前端代码 (Vue 3)
|
||||
│ ├── src/
|
||||
│ │ ├── components/FileSystem/ # 文件管理主组件
|
||||
│ │ ├── stores/ # Pinia 状态管理
|
||||
│ │ ├── api/ # 后端调用封装
|
||||
│ │ └── utils/ # 工具函数
|
||||
│ └── vite.config.js
|
||||
├── build/ # 构建配置(跨平台)
|
||||
│ ├── config.yml # Wails 项目配置
|
||||
│ └── windows/ # Windows 构建脚本
|
||||
└── configs/ # 运行时配置
|
||||
```
|
||||
|
||||
```
|
||||
wails3 build
|
||||
```
|
||||
## 开发
|
||||
|
||||
This will create a production-ready executable in the `build` directory.
|
||||
```bash
|
||||
# 安装依赖
|
||||
wails3 task common:install:frontend:deps
|
||||
|
||||
## Exploring Wails3 Features
|
||||
# 启动开发模式(热重载)
|
||||
wails3 dev
|
||||
|
||||
Now that you have your project set up, it's time to explore the features that Wails3 offers:
|
||||
# 生产构建
|
||||
wails3 build
|
||||
```
|
||||
|
||||
1. **Check out the examples**: The best way to learn is by example. Visit the `examples` directory in the `v3/examples` directory to see various sample applications.
|
||||
### 构建标签
|
||||
|
||||
2. **Run an example**: To run any of the examples, navigate to the example's directory and use:
|
||||
- `production` — 生产模式,使用嵌入的 frontend dist
|
||||
- `devtools` — 在生产构建中保留 DevTools(F12)
|
||||
|
||||
```
|
||||
go run .
|
||||
```
|
||||
## 快捷键
|
||||
|
||||
Note: Some examples may be under development during the alpha phase.
|
||||
| 快捷键 | 功能 |
|
||||
|--------|------|
|
||||
| Ctrl+B | 切换侧边栏 |
|
||||
| Ctrl+H | 历史记录 |
|
||||
| Ctrl+F | 聚焦搜索 |
|
||||
|
||||
3. **Explore the documentation**: Visit the [Wails3 documentation](https://v3.wails.io/) for in-depth guides and API references.
|
||||
## 版本历史
|
||||
|
||||
4. **Join the community**: Have questions or want to share your progress? Join the [Wails Discord](https://discord.gg/JDdSxwjhGf) or visit the [Wails discussions on GitHub](https://github.com/wailsapp/wails/discussions).
|
||||
|
||||
## Project Structure
|
||||
|
||||
Take a moment to familiarize yourself with your project structure:
|
||||
|
||||
- `frontend/`: Contains your frontend code (HTML, CSS, JavaScript/TypeScript)
|
||||
- `main.go`: The entry point of your Go backend
|
||||
- `app.go`: Define your application structure and methods here
|
||||
- `wails.json`: Configuration file for your Wails project
|
||||
|
||||
## Next Steps
|
||||
|
||||
1. Modify the frontend in the `frontend/` directory to create your desired UI.
|
||||
2. Add backend functionality in `main.go`.
|
||||
3. Use `wails3 dev` to see your changes in real-time.
|
||||
4. When ready, build your application with `wails3 build`.
|
||||
|
||||
Happy coding with Wails3! If you encounter any issues or have questions, don't hesitate to consult the documentation or reach out to the Wails community.
|
||||
详见 [CHANGELOG.md](./CHANGELOG.md)
|
||||
|
||||
Reference in New Issue
Block a user