DeskCut 项目使用与配置指南

1. 项目目录结构及介绍

DeskCut 项目的主要目录结构如下：

 DeskCut
 ├── build/                # 构建相关文件
 ├── icons/                # 项目图标资源
 ├── main/                 # 主程序代码
 ├── renderer/             # 渲染器相关代码
 ├── .gitignore            # Git 忽略文件
 ├── LICENSE              # 项目许可证
 ├── README.md            # 项目说明文件
 ├── package.json         # 项目配置文件
 ├── postcss.config.js     # PostCSS 配置文件
 ├── tailwind.config.js    # Tailwind CSS 配置文件
 ├── yarn.lock             # Yarn 锁文件

• build/：包含项目的构建脚本和工具链配置。
• icons/：存放项目所需的图标资源。
• main/：包含项目的主逻辑代码，例如启动应用、处理系统事件等。
• renderer/：包含用户界面相关的代码，通常用于构建应用窗口和交互元素。
• .gitignore：定义哪些文件和目录应该被 Git 忽略。
• LICENSE：项目使用的许可证信息，本项目采用 GPL-2.0 许可。
• README.md：项目的说明文档，包含项目的描述、使用方法等信息。
• package.json：项目的元数据文件，定义了项目的依赖、脚本和配置信息。
• postcss.config.js：PostCSS 的配置文件，用于处理 CSS 的转换和优化。
• tailwind.config.js：Tailwind CSS 配置文件，用于定制 Tailwind 的行为。
• yarn.lock：记录项目依赖的精确版本，确保在不同环境中安装的依赖一致。

2. 项目的启动文件介绍

项目的主要启动文件位于 main/ 目录中。以下是主要的启动文件：

• index.js：这是项目的主入口文件，通常用于设置应用的主窗口和启动应用。
• app.js：负责应用级别的逻辑，如创建菜单、处理应用生命周期事件等。

启动项目时，通常会在项目根目录下运行以下命令：

npm run start

或者如果使用 Yarn：

yarn start

3. 项目的配置文件介绍

项目的配置主要通过以下几个文件进行：

• package.json：这个文件包含了项目的名称、版本、描述、入口文件、脚本、依赖等信息。以下是一些重要的字段：

  {
    "name": "deskcut",
    "version": "1.5.0",
    "main": "main/index.js",
    "scripts": {
      "start": "electron .",
      "dist": "electron-builder --dir"
    },
    "dependencies": {
      "electron": "^11.0.1"
    }
  }
  

• tailwind.config.js：Tailwind CSS 的配置文件，可以在这里定义全局样式变量、插件等。

  module.exports = {
    purge: [],
    darkMode: false, // or 'media' or 'class'
    theme: {
      extend: {},
    },
    variants: {
      extend: {},
    },
    plugins: [],
  }
  

• postcss.config.js：PostCSS 的配置文件，通常用于进一步处理 CSS。

  module.exports = {
    plugins: {
      tailwindcss: {},
      autoprefixer: {},
    },
  }
  

这些配置文件为项目提供了所需的样式处理和打包配置，确保应用能够按预期运行和构建。