# 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.
---
## โจ 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 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** to be 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)
---
Built with โค๏ธ for developers who appreciate good design.