# 禅心闹钟

**Repository Path**: koreantion/Zen_Heart_Alarm_Clock

## Basic Information

- **Project Name**: 禅心闹钟
- **Description**: 基于electron框架实现的定时闹钟桌面应用
- **Primary Language**: JavaScript
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-02-22
- **Last Updated**: 2024-02-28

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

<h2 align="center">Zen Heart Alarm Clock</h2>
<div align="center"><img src="https://img.shields.io/badge/node-20.11.0-green">&nbsp;&nbsp;&nbsp;<img src="https://img.shields.io/badge/npm-10.2.4-green"></div>

### 介绍
[禅心闹钟](https://gitee.com/koreantion/Zen_Heart_Alarm_Clock)是一个基于 Electron 框架开发的桌面应用，旨在帮助用户管理时间，提高专注力。应用使用 Node.js 的内置时间方法实现每900秒（即15分钟）播放一次 mp3 格式的闹钟声音。软件的左上角显示用户已经专注的时间，帮助用户追踪专注时长。该软还支持右下角托盘隐藏并在后台运行，右键点击右小角该应用的图标，实现关闭程序的功能。

### 软件架构
该应用基于 Electron 框架构建。Electron 允许使用 Web 技术如 HTML, CSS, JavaScript 来开发跨平台的桌面应用。本项目主要分为两部分：

主进程：负责应用生命周期管理、窗口管理等。
渲染进程：显示用户界面和处理用户交互。
应用逻辑主要在渲染进程中实现，使用 Node.js 的 setTimeout 来处理时间间隔，通过 HTML5 的 Audio API 播放音乐。

### 安装教程
克隆仓库到本地 git clone <仓库地址>
进入项目目录 cd 定时闹钟
安装依赖 npm install
如果在中国大陆，设置 Electron 镜像以加速下载速度：
`set ELECTRON_MIRROR=http://npm.taobao.org/mirrors/electron/&& npm install electron --save-dev`

### 使用说明
开发环境运行：
`npm run start`
打包应用：
首先安装 electron-builder
`npm install electron-builder -g`，在[相关依赖文件](https://download.csdn.net/download/2301_78992106/88865335?spm=1001.2014.3001.5503)解压到`C:\Users\your username\AppData\Local`
然后执行打包命令：
`npx electron-builder`

### 功能说明
- **定时提醒**：应用每隔900秒自动播放预设的闹钟音效，帮助用户管理专注时间。
- **时间追踪**：应用界面左上角显示从应用启动到当前的专注时间。
- **自定义提醒音乐**：用户可以通过修改应用设置来更换提醒时播放的 mp3 文件。
- **右下角隐藏**：用户可以通过右键点击右小角托盘图标选择关闭该应用。

### 版本更新：
#### v1.0    最新版本

### 参与贡献
Fork 本仓库。
创建你的特性分支 (git checkout -b feature/fooBar)。
提交你的更改 (git commit -am 'Add some fooBar')。
将你的更改推送到远程仓库 (git push origin feature/fooBar)。
创建一个新的 Pull Request。