mirror of
https://gitee.com/tuxmonkey/Helix
synced 2026-10-23 18:52:18 +08:00
Compare commits
2 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| bae7b0ad51 | |||
| 7246343e9e |
21
LICENSE
Normal file
21
LICENSE
Normal file
@@ -0,0 +1,21 @@
|
||||
MIT License
|
||||
|
||||
Copyright (c) 2026 Helix
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
125
README.md
125
README.md
@@ -1,50 +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
|
||||
|
||||
> 一款 Apple 设计风格的 Git 仓库可视化管理工具，基于 Electron 构建。
|
||||
> 🧬 一款 Apple 设计风格的 Git 仓库可视化管理工具，基于 Electron 构建。
|
||||
|
||||
## 特性
|
||||
让 Git 操作变得可见：浏览提交历史、管理分支、暂存提交变更、同步远程仓库 —— 一切尽在清爽原生的界面中，支持浅色 / 深色双主题。
|
||||
|
||||
- 可视化提交历史、分支管理、工作区变更
|
||||
- Stage / Unstage / Commit 工作流
|
||||
- 分支创建与切换
|
||||
- Fetch / Pull / Push 远程同步
|
||||
- 中文 / English 双语界面，一键切换
|
||||
- MiSans 中文字体优先，自动回退系统字体
|
||||
- 浅色 / 深色双主题，跟随系统
|
||||
<p align="center">
|
||||
<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>
|
||||
|
||||
## 技术栈
|
||||
---
|
||||
|
||||
- **Electron** 43 — 跨平台桌面框架
|
||||
- **Vanilla JS** — 零框架依赖
|
||||
- **Apple Design** — 弹簧动画、半透明材质、SF Pro / MiSans 字体体系
|
||||
## ✨ 特性
|
||||
|
||||
## 运行
|
||||
- **📜 可视化提交历史** — 图形化展示 commit 图、作者、日期和信息
|
||||
- **🌿 分支管理** — 创建、切换分支，查看上游跟踪状态
|
||||
- **📝 智能暂存** — 按文件 Stage / Unstage，查看差异，撰写干净的提交
|
||||
- **🔄 远程同步** — 一键 Fetch / Pull / Push
|
||||
- **🌐 双语界面** — 中文 / English 完整翻译，一键切换
|
||||
- **🎨 双主题** — 浅色 / 深色模式，自动跟随系统偏好
|
||||
- **🪟 无边框窗口** — 自定义标题栏，原生般的窗口控制
|
||||
- **⚡ 零框架依赖** — 渲染进程纯 Vanilla JS，无 React/Vue/Angular
|
||||
|
||||
## 📥 下载
|
||||
|
||||
预编译安装包请前往 [Releases](https://github.com/TuxMonkey2004/Helix/releases) 页面下载。
|
||||
|
||||
| 平台 | 安装包 |
|
||||
|------|--------|
|
||||
| 🪟 Windows | `Helix-Setup-x.x.x.exe`（安装版）或 `Helix-x.x.x.exe`（便携版） |
|
||||
| 🍎 macOS | `Helix-x.x.x.dmg`（Intel）或 `Helix-x.x.x-arm64.dmg`（Apple Silicon） |
|
||||
| 🐧 Linux | `Helix-x.x.x.AppImage` 或 `Helix_x.x.x_amd64.deb` |
|
||||
|
||||
> 需要系统已安装 **Git**。
|
||||
|
||||
## 🚀 快速开始
|
||||
|
||||
### 从源码运行
|
||||
|
||||
```bash
|
||||
git clone https://github.com/TuxMonkey2004/Helix.git
|
||||
cd Helix
|
||||
npm install
|
||||
npm start
|
||||
```
|
||||
|
||||
## 构建
|
||||
### 构建安装包
|
||||
|
||||
```bash
|
||||
# Windows 安装包
|
||||
npm run build
|
||||
# 按平台构建
|
||||
npm run build:win # Windows (.exe)
|
||||
npm run build:mac # macOS (.dmg)
|
||||
npm run build:linux # Linux (.AppImage, .deb)
|
||||
|
||||
# Windows 便携版
|
||||
npm run build:portable
|
||||
# 全平台构建
|
||||
npm run build:all
|
||||
```
|
||||
|
||||
## 项目结构
|
||||
## 🧱 技术栈
|
||||
|
||||
| 层级 | 技术 |
|
||||
|------|------|
|
||||
| 框架 | Electron 43 |
|
||||
| 渲染 | Vanilla JS + CSS 自定义属性 |
|
||||
| 字体 | SF Pro / MiSans 字体体系 |
|
||||
| 设计 | Apple Human Interface Guidelines |
|
||||
| 构建 | electron-builder |
|
||||
|
||||
## 📁 项目结构
|
||||
|
||||
```
|
||||
Helix/
|
||||
├── main.js # Electron 主进程，Git 操作
|
||||
├── preload.js # 安全 IPC 桥接
|
||||
├── main.js # Electron 主进程 — Git IPC、窗口管理
|
||||
├── preload.js # 安全上下文桥接（contextIsolation）
|
||||
├── package.json
|
||||
├── .github/
|
||||
│ └── workflows/
|
||||
│ └── build.yml # CI/CD — 跨平台构建与发布
|
||||
└── src/
|
||||
├── index.html # 界面布局
|
||||
├── styles.css # Apple 设计系统样式
|
||||
├── i18n.js # 中英文翻译
|
||||
└── renderer.js # 渲染逻辑
|
||||
├── styles.css # Apple 风格设计系统
|
||||
├── i18n.js # 中 / 英 翻译
|
||||
└── renderer.js # UI 逻辑、提交图、差异查看
|
||||
```
|
||||
|
||||
## 🧪 开发
|
||||
|
||||
```bash
|
||||
# 带 DevTools 启动
|
||||
npm run dev
|
||||
|
||||
# 代码检查（即将推出）
|
||||
# npm run lint
|
||||
|
||||
# 测试（即将推出）
|
||||
# npm test
|
||||
```
|
||||
|
||||
## 🤝 参与贡献
|
||||
|
||||
欢迎贡献代码！基本流程：
|
||||
|
||||
1. Fork 本仓库
|
||||
2. 创建特性分支 (`git checkout -b feat/amazing-feature`)
|
||||
3. 提交更改 (`git commit -m '添加了某某功能'`)
|
||||
4. 推送到分支 (`git push origin feat/amazing-feature`)
|
||||
5. 发起 Pull Request
|
||||
|
||||
请保持代码风格一致 —— 渲染层不使用框架依赖。
|
||||
|
||||
## 📄 许可证
|
||||
|
||||
MIT © [Helix](https://github.com/TuxMonkey2004/Helix)
|
||||
|
||||
---
|
||||
|
||||
<p align="center">
|
||||
<sub>用 ❤️ 为注重设计的开发者而构建</sub>
|
||||
</p>
|
||||
|
||||
125
README_en.md
Normal file
125
README_en.md
Normal 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>
|
||||
Reference in New Issue
Block a user