couplet 的安装和配置教程

项目基础介绍

couplet 是一款将传统春联以现代方式展现的跨平台桌面应用。它能够在用户的电脑桌面上实时展示春联，增添节日气氛。couplet 支持 Windows、macOS、Linux 等操作系统，同时提供了自定义字体和样式、深色模式适配以及多语言支持（开发中）等功能。

项目主要编程语言

该项目主要使用 TypeScript 进行开发，同时也使用了 JavaScript、CSS 和 HTML 等技术。

项目使用的关键技术和框架

couplet 使用了以下关键技术框架：

• Electron：用于构建跨平台桌面应用的框架。
• Vite：一个用于现代 Web 开发的构建工具。
• TypeScript：JavaScript 的一个超集，添加了静态类型选项。
• ESLint：用于识别和报告代码中的模式匹配。

项目安装和配置的准备工作

在开始安装和配置 couplet 项目之前，请确保您的系统中已经安装以下依赖：

1. Node.js 和 npm：Node.js 是一个基于 Chrome V8 引擎的 JavaScript 运行环境，npm 是随 Node.js 一起安装的包管理工具。
2. pnpm 或 npm：pnpm 是一个快速、节省磁盘空间的包管理工具，本项目推荐使用 pnpm，但也可以使用 npm。

项目安装步骤

1. 克隆项目仓库到本地

   打开命令行工具，执行以下命令克隆项目：

   git clone https://github.com/liou666/couplet.git
   

2. 安装项目依赖

   进入项目目录，执行以下命令安装项目依赖：

   cd couplet
   pnpm install
   

   如果 Electron 安装失败，可以尝试设置淘宝镜像源：

   export ELECTRON_MIRROR=http://npm.taobao.org/mirrors/electron/ && pnpm i
   

3. 启动项目

   安装完依赖后，执行以下命令启动项目：

   pnpm dev
   

   这将启动开发服务器，并在默认浏览器中打开应用。

按照上述步骤操作，即可完成 couplet 项目的安装和配置。现在您可以开始使用该应用，并将春节氛围带到您的电脑桌面上。