Skip to content

qinsehm1128/treaminal_pro

Repository files navigation

Treaminal Pro

一个现代化的跨平台终端模拟器,基于 Tauri 构建,提供原生桌面应用体验。

✨ 功能特性

  • 🖥️ 跨平台支持 - Windows、macOS、Linux 原生应用
  • 🐚 多 Shell 支持 - Command Prompt、PowerShell、Git Bash
  • 📑 多标签页 - 支持多个终端会话并行工作
  • 🪟 窗口管理 - 最小化到系统托盘,节省桌面空间
  • 高性能 - 基于 Rust 和 Tauri 的原生性能
  • 🎨 现代化 UI - 基于 React 的美观界面
  • 🔧 编码自适应 - 自动检测和处理 UTF-8/GBK 编码
  • 📱 响应式设计 - 适配不同屏幕尺寸

🛠️ 技术栈

前端

  • React 19 - 现代化用户界面框架
  • Vite - 快速构建工具
  • XTerm.js - 终端模拟器组件
  • Zustand - 轻量级状态管理
  • CSS3 - 现代化样式设计

后端

  • Rust - 高性能系统编程语言
  • Tauri - 跨平台桌面应用框架
  • Tokio - 异步运行时
  • Portable PTY - 跨平台伪终端支持

开发工具

  • TypeScript - 类型安全的 JavaScript
  • ESLint - 代码质量检查
  • Prettier - 代码格式化

🚀 安装指南

系统要求

  • Windows: Windows 10 及以上

从源码构建

  1. 克隆项目

    git clone https://github.com/your-username/treaminal_pro.git
    cd treaminal_pro
  2. 安装前端依赖

    npm install
    #
    yarn install
  3. 安装 Rust 工具链

    这部分建议看tauri官网 https://v2.tauri.app/zh-cn/start/prerequisites/

  4. 运行开发服务器

    npm run tauri dev
    #
    yarn tauri dev

构建生产版本

  1. 构建前端

    npm run build
  2. 构建 Tauri 应用

    npm run tauri build
  3. 安装程序位置

    • Windows: src-tauri/target/release/bundle/msi/

📖 使用说明

基本操作

  1. 创建新终端会话

    • 点击顶部命令面板
    • 选择要使用的 Shell (Command Prompt、PowerShell、Git Bash)
    • 可选:设置工作目录和初始命令
    • 点击"运行"按钮
  2. 管理终端会话

    • 使用标签页切换不同的终端会话
    • 点击标签页上的 ✕ 关闭会话
    • 拖拽标签页重新排序
  3. 窗口控制

    • 点击系统托盘图标显示/隐藏窗口
    • 双击托盘图标切换窗口状态
    • 右键托盘图标显示菜单选项

🔧 开发指南

项目结构

treaminal_pro/
├── src/                    # React 前端代码
│   ├── components/         # React 组件
│   ├── state/             # Zustand 状态管理
│   ├── App.jsx            # 主应用组件
│   └── main.jsx           # 应用入口
├── src-tauri/             # Tauri 后端代码
│   ├── src/               # Rust 源码
│   │   ├── lib.rs         # Tauri 应用配置
│   │   └── terminal.rs    # 终端功能实现
│   └── Cargo.toml         # Rust 依赖配置
├── public/                # 静态资源
├── package.json           # Node.js 依赖和脚本
└── vite.config.js         # Vite 配置

添加新功能

  1. 前端功能

    • src/components/ 中添加新组件
    • src/state/ 中添加状态管理逻辑
    • 更新 App.jsx 集成新功能
  2. 后端功能

    • src-tauri/src/ 中添加新的 Rust 模块
    • lib.rs 中注册新的 Tauri 命令
    • 更新 Cargo.toml 添加必要依赖
  3. 构建和测试

    npm run tauri dev    # 开发模式
    npm run tauri build  # 生产构建

代码规范

  • JavaScript/TypeScript: 遵循 ESLint 配置
  • Rust: 遵循 rustfmt 格式化
  • CSS: 使用 CSS 变量和响应式设计
  • Git: 使用 conventional commits

🤝 贡献指南

我们欢迎所有形式的贡献!

  1. Fork 本项目
  2. 创建功能分支 (git checkout -b feature/AmazingFeature)
  3. 提交更改 (git commit -m 'Add some AmazingFeature')
  4. 推送到分支 (git push origin feature/AmazingFeature)
  5. 创建 Pull Request

开发环境设置

# 安装开发依赖
npm install

# 运行测试
npm test

# 代码格式化
npm run format

# 代码检查
npm run lint

📄 许可证

本项目采用 MIT 许可证 - 查看 LICENSE 文件了解详情。

🙏 致谢

  • Tauri - 优秀的跨平台应用框架
  • XTerm.js - 强大的终端模拟器
  • React - 现代化的前端框架
  • Rust - 高性能的系统编程语言

用 ❤️ 构建,期待您的使用和反馈!

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors