TuxMonkey/Helix
1
0
Fork 0
mirror of https://gitee.com/tuxmonkey/Helix synced 2026-10-23 10:42:20 +08:00
Code Issues Packages Projects Releases Wiki Activity

Use Chinese for README, add separate English README_en.md

Browse Source
This commit is contained in:
TuxMonkey
2026-08-04 01:11:14 +08:00
parent 7246343e9e
commit bae7b0ad51
2 changed files with 180 additions and 55 deletions
Download Patch File Download Diff File Expand all files Collapse all files

110
README.md
View File

@@ -6,42 +6,42 @@
# Helix # Helix
> 🧬 A beautiful, Apple-inspired Git repository manager built with Electron. > 🧬 一款 Apple 设计风格的 Git 仓库可视化管理工具，基于 Electron 构建。
Helix makes Git visual. Browse commit history, manage branches, stage and commit changes, and sync with remotes — all through a clean, native-feeling interface with light & dark themes. 让 Git 操作变得可见：浏览提交历史、管理分支、暂存提交变更、同步远程仓库 —— 一切尽在清爽原生的界面中，支持浅色 / 深色双主题。
<p align="center"> <p align="center">
<img src="https://raw.githubusercontent.com/TuxMonkey2004/Helix/main/.github/screenshot.png" alt="Helix Screenshot" width="800" style="border-radius: 12px; box-shadow: 0 8px 30px rgba(0,0,0,0.12);" /> <img src="https://raw.githubusercontent.com/TuxMonkey2004/Helix/main/.github/screenshot.png" alt="Helix 截图" width="800" style="border-radius: 12px; box-shadow: 0 8px 30px rgba(0,0,0,0.12);" />
</p> </p>
--- ---
## ✨ Features ## ✨ 特性
- **📜 Visual Commit History** — Browse commits with graph, author, date, and message at a glance - **📜 可视化提交历史** — 图形化展示 commit 图、作者、日期和信息
- **🌿 Branch Management** — Create, switch, and track branches with upstream status - **🌿 分支管理** — 创建、切换分支，查看上游跟踪状态
- **📝 Smart Staging** — Stage / unstage individual files, view diffs, and craft clean commits - **📝 智能暂存** — 按文件 Stage / Unstage，查看差异，撰写干净的提交
- **🔄 Remote Sync** — Fetch, pull, and push with a single click - **🔄 远程同步** — 一键 Fetch / Pull / Push
- **🌐 i18n** — Full Chinese &amp; English interface, toggle instantly - **🌐 双语界面** — 中文 / English 完整翻译，一键切换
- **🎨 Themes** — Light &amp; dark mode, auto-follows system preference - **🎨 双主题** — 浅色 / 深色模式，自动跟随系统偏好
- **🪟 Frameless Window** — Custom title bar with native-feeling controls - **🪟 无边框窗口** — 自定义标题栏，原生般的窗口控制
- **⚡ Zero Dependencies** — Vanilla JavaScript renderer, no React/Vue/Angular - **⚡ 零框架依赖** — 渲染进程纯 Vanilla JS，无 React/Vue/Angular
## 📥 Download ## 📥 下载
Prebuilt binaries are available on the [Releases](https://github.com/TuxMonkey2004/Helix/releases) page. 预编译安装包请前往 [Releases](https://github.com/TuxMonkey2004/Helix/releases) 页面下载。
| Platform | Package | | 平台 | 安装包 |
|----------|---------| |------|--------|
| 🪟 Windows | `Helix-Setup-x.x.x.exe` (installer) or `Helix-x.x.x.exe` (portable) | | 🪟 Windows | `Helix-Setup-x.x.x.exe`（安装版）或 `Helix-x.x.x.exe`（便携版） |
| 🍎 macOS | `Helix-x.x.x.dmg` (Intel) or `Helix-x.x.x-arm64.dmg` (Apple Silicon) | | 🍎 macOS | `Helix-x.x.x.dmg`（Intel）或 `Helix-x.x.x-arm64.dmg`（Apple Silicon） |
| 🐧 Linux | `Helix-x.x.x.AppImage` or `Helix_x.x.x_amd64.deb` | | 🐧 Linux | `Helix-x.x.x.AppImage` 或 `Helix_x.x.x_amd64.deb` |
> Requires **Git** to be installed on your system. > 需要系统已安装 **Git**。
## 🚀 Quick Start ## 🚀 快速开始
### Run from source ### 从源码运行
```bash ```bash
git clone https://github.com/TuxMonkey2004/Helix.git git clone https://github.com/TuxMonkey2004/Helix.git
@@ -50,76 +50,76 @@ npm install
npm start npm start
``` ```
### Build installers ### 构建安装包
```bash ```bash
# Platform-specific # 按平台构建
npm run build:win # Windows (.exe) npm run build:win # Windows (.exe)
npm run build:mac # macOS (.dmg) npm run build:mac # macOS (.dmg)
npm run build:linux # Linux (.AppImage, .deb) npm run build:linux # Linux (.AppImage, .deb)
# All platforms # 全平台构建
npm run build:all npm run build:all
``` ```
## 🧱 Tech Stack ## 🧱 技术栈
| Layer | Technology | | 层级 | 技术 |
|-------|------------| |------|------|
| Framework | Electron 43 | | 框架 | Electron 43 |
| Renderer | Vanilla JS + CSS Custom Properties | | 渲染 | Vanilla JS + CSS 自定义属性 |
| Typography | SF Pro / MiSans font stack | | 字体 | SF Pro / MiSans 字体体系 |
| Design | Apple Human Interface Guidelines | | 设计 | Apple Human Interface Guidelines |
| Build | electron-builder | | 构建 | electron-builder |
## 📁 Project Structure ## 📁 项目结构
``` ```
Helix/ Helix/
├── main.js # Electron main process — Git IPC, window management ├── main.js # Electron 主进程 — Git IPC、窗口管理
├── preload.js # Secure context bridge (contextIsolation) ├── preload.js # 安全上下文桥接（contextIsolation）
├── package.json ├── package.json
├── .github/ ├── .github/
│ └── workflows/ │ └── workflows/
│ └── build.yml # CI/CD — cross-platform build & release │ └── build.yml # CI/CD — 跨平台构建与发布
└── src/ └── src/
├── index.html # Application layout ├── index.html # 界面布局
├── styles.css # Apple-inspired design system ├── styles.css # Apple 风格设计系统
├── i18n.js # zh-CN / en translations ├── i18n.js # 中 / 英 翻译
└── renderer.js # UI logic, commit graph, diff viewer └── renderer.js # UI 逻辑、提交图、差异查看
``` ```
## 🧪 Development ## 🧪 开发
```bash ```bash
# Start with DevTools open # 带 DevTools 启动
npm run dev npm run dev
# Lint (coming soon) # 代码检查（即将推出）
# npm run lint # npm run lint
# Test (coming soon) # 测试（即将推出）
# npm test # npm test
``` ```
## 🤝 Contributing ## 🤝 参与贡献
Contributions are welcome! Here's how: 欢迎贡献代码！基本流程：
1. Fork the repository 1. Fork 本仓库
2. Create a feature branch (`git checkout -b feat/amazing-feature`) 2. 创建特性分支 (`git checkout -b feat/amazing-feature`)
3. Commit your changes (`git commit -m 'Add amazing feature'`) 3. 提交更改 (`git commit -m '添加了某某功能'`)
4. Push to the branch (`git push origin feat/amazing-feature`) 4. 推送到分支 (`git push origin feat/amazing-feature`)
5. Open a Pull Request 5. 发起 Pull Request
Please keep the code style consistent — no framework dependencies in the renderer. 请保持代码风格一致 —— 渲染层不使用框架依赖。
## 📄 License ## 📄 许可证
MIT © [Helix](https://github.com/TuxMonkey2004/Helix) MIT © [Helix](https://github.com/TuxMonkey2004/Helix)
--- ---
<p align="center"> <p align="center">
<sub>Built with ❤️ for developers who appreciate good design.</sub> <sub>用 ❤️ 为注重设计的开发者而构建</sub>
</p> </p>

125
README_en.md Normal file
View File

@@ -0,0 +1,125 @@
<p align="center">
<img src="https://img.shields.io/badge/version-0.1.0-blue" alt="version">
<img src="https://img.shields.io/badge/license-MIT-green" alt="license">
<img src="https://img.shields.io/badge/platform-Windows%20%7C%20macOS%20%7C%20Linux-lightgrey" alt="platform">
</p>
# Helix
> 🧬 A beautiful, Apple-inspired Git repository manager built with Electron.
Helix makes Git visual. Browse commit history, manage branches, stage and commit changes, and sync with remotes — all through a clean, native-feeling interface with light & dark themes.
<p align="center">
<img src="https://raw.githubusercontent.com/TuxMonkey2004/Helix/main/.github/screenshot.png" alt="Helix Screenshot" width="800" style="border-radius: 12px; box-shadow: 0 8px 30px rgba(0,0,0,0.12);" />
</p>
---
## ✨ Features
- **📜 Visual Commit History** — browse commits with graph, author, date, and message at a glance
- **🌿 Branch Management** — create, switch, and track branches with upstream status
- **📝 Smart Staging** — stage / unstage individual files, view diffs, and craft clean commits
- **🔄 Remote Sync** — fetch, pull, and push with a single click
- **🌐 i18n** — full Chinese & English interface, toggle instantly
- **🎨 Themes** — light & dark mode, auto-follows system preference
- **🪟 Frameless Window** — custom title bar with native-feeling window controls
- **⚡ Zero Dependencies** — Vanilla JavaScript renderer, no React/Vue/Angular
## 📥 Download
Prebuilt binaries are available on the [Releases](https://github.com/TuxMonkey2004/Helix/releases) page.
| Platform | Package |
|----------|---------|
| 🪟 Windows | `Helix-Setup-x.x.x.exe` (installer) or `Helix-x.x.x.exe` (portable) |
| 🍎 macOS | `Helix-x.x.x.dmg` (Intel) or `Helix-x.x.x-arm64.dmg` (Apple Silicon) |
| 🐧 Linux | `Helix-x.x.x.AppImage` or `Helix_x.x.x_amd64.deb` |
> Requires **Git** installed on your system.
## 🚀 Quick Start
### Run from source
```bash
git clone https://github.com/TuxMonkey2004/Helix.git
cd Helix
npm install
npm start
```
### Build installers
```bash
# Platform-specific
npm run build:win # Windows (.exe)
npm run build:mac # macOS (.dmg)
npm run build:linux # Linux (.AppImage, .deb)
# All platforms
npm run build:all
```
## 🧱 Tech Stack
| Layer | Technology |
|-------|------------|
| Framework | Electron 43 |
| Renderer | Vanilla JS + CSS Custom Properties |
| Typography | SF Pro / MiSans font stack |
| Design | Apple Human Interface Guidelines |
| Build | electron-builder |
## 📁 Project Structure
```
Helix/
├── main.js # Electron main process — Git IPC, window management
├── preload.js # Secure context bridge (contextIsolation)
├── package.json
├── .github/
│ └── workflows/
│ └── build.yml # CI/CD — cross-platform build & release
└── src/
├── index.html # Application layout
├── styles.css # Apple-inspired design system
├── i18n.js # zh-CN / en translations
└── renderer.js # UI logic, commit graph, diff viewer
```
## 🧪 Development
```bash
# Start with DevTools open
npm run dev
# Lint (coming soon)
# npm run lint
# Test (coming soon)
# npm test
```
## 🤝 Contributing
Contributions are welcome! Here's how:
1. Fork the repository
2. Create a feature branch (`git checkout -b feat/amazing-feature`)
3. Commit your changes (`git commit -m 'Add amazing feature'`)
4. Push to the branch (`git push origin feat/amazing-feature`)
5. Open a Pull Request
Please keep the code style consistent — no framework dependencies in the renderer.
## 📄 License
MIT © [Helix](https://github.com/TuxMonkey2004/Helix)
---
<p align="center">
<sub>Built with ❤️ for developers who appreciate good design.</sub>
</p>