# electron-template

**Repository Path**: lee-personal/electron-template

## Basic Information

- **Project Name**: electron-template
- **Description**: element + ts +sqlite +vue  模版项目
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-12-19
- **Last Updated**: 2026-01-06

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

The provided project appears to be an Electron-based application with a web frontend and various backend components. Based on the structure and code map, here's a comprehensive README tailored to this project:

---

# Electron Template

这是一个基于 Electron 的应用程序模板，结合了 Web 前端和本地功能，适用于构建跨平台桌面应用。

## 项目结构概览

- **packages/electron**: Electron 主进程代码，包含启动窗口、本地服务器、数据库操作等功能。
- **packages/web**: Web 前端代码，基于 Vue.js 框架，用于构建用户界面。
- **script**: 构建和部署脚本，如打包 Electron 应用、复制 Web 构建文件等。
- **pnpm 相关文件**: 支持 pnpm 包管理和多包工作区配置。

## 主要功能

- 使用 Electron 构建本地桌面应用。
- 集成 SQLite 数据库支持。
- 提供本地 HTTP 服务器用于前后端通信。
- Web 前端使用 Vue 3 + TypeScript 构建。
- 支持热更新、TypeScript 类型检查、ESLint 代码规范等开发特性。

## 开发环境搭建

### 系统要求

- Node.js (v16.x 或更高)
- pnpm (可通过 `npm install -g pnpm` 安装)
- Git

### 安装依赖

```bash
pnpm install
```

### 启动开发服务器

```bash
# 启动 Web 前端开发服务器
pnpm run web:dev

# 启动 Electron 应用
pnpm run electron:dev
```

## 构建与发布

### 构建生产版本

```bash
pnpm run build
```

该命令会依次构建 Web 前端并打包 Electron 应用。

### 打包 Electron 应用

```bash
pnpm run electron:build
```

使用 `electron-builder` 打包为 Windows/macOS/Linux 平台的应用程序。

## 使用 SQLite 数据库

项目中集成了 SQLite 数据库支持，通过 `packages/electron/src/sqlite/` 下的模块进行操作，包括：

- 数据类型转换
- 表结构管理
- CRUD 操作封装

## 自定义日志输出

使用 `CustomConsole` 类实现彩色日志输出，并支持日志格式化、调试信息打印等功能。

## 窗口尺寸管理

通过 `WindowSize` 类实现窗口尺寸的持久化保存与恢复。

## 贡献指南

欢迎贡献代码和改进文档。请遵循以下步骤：

1. Fork 本仓库
2. 创建新分支 (`git checkout -b feature/new-feature`)
3. 提交更改 (`git commit -am 'Add some feature'`)
4. 推送分支 (`git push origin feature/new-feature`)
5. 创建 Pull Request

## 许可证

本项目采用 MIT 许可证。详见 LICENSE 文件。

--- 

如需进一步了解具体模块的实现，请参考各目录下的源码文件。