Devex

🚀 DevEx – 開源雲集成開發環境平臺

DevEx 是一個開源的雲開發環境平臺，能讓你在瀏覽器中隨時隨地運行全功能的、基於容器的開發環境，就像在本地一樣。它還提供 AI 輔助和安全的沙箱功能，藉助 Kubernetes、WebSocket 和 GoLang 實現可擴展的 REPL 會話。

🚀 快速開始

DevEx 是一個開源平臺，可創建基於雲的開發環境（REPLs），其使用體驗與本地環境無異，但你可以在任何時間、任何地點通過瀏覽器訪問。它具有高度的靈活性，你可以使用自己喜歡的技術棧進行編碼，通過 SSH 連接，或者通過我們的 MCP 服務器與 AI 代理運行會話。此外，它還支持安全地沙箱化 AI 生成的代碼，讓你在隔離的環境中測試實際更改。與 Gitpod 或 E2B 不同，DevEx 輕量級、可自託管，並且從一開始就是為生產環境設計的，擁有以開發者為中心的 CLI、無縫的 AI 集成以及基於 Kubernetes 的原生設計，可實現無限擴展。

📣 想添加自己的 REPL 模板？很簡單！ 👉 閱讀貢獻指南 即可開始。

✨ 主要特性

• 🔐 GitHub OAuth 認證
• 🪄 通過核心 API 創建、啟動、停止、刪除 REPLs
• 💾 基於 S3 的文件持久化
• 📦 每個 REPL 的 Kubernetes 部署（動態）
• 📡 基於 WebSocket 的編輯器和終端
• 🧹 用於清理和同步的臨時容器
• 🔒 通過 Let's Encrypt 和 Cert Manager 實現 HTTPS 和 TLS
• 🎨 美觀的 Next.js + Tailwind 前端

⚙️ 工作原理

graph TB
    User[👤 用戶] --> Web[🌐 前端網頁<br/>React/Next.js 應用程序]
    Web --> Core[🔧 核心後端<br/>• 用戶認證<br/>• REPL 管理<br/>• S3 集成<br/>• K8s 編排]
    Core --> S3[(🗄️ S3 存儲<br/>用戶名/REPL ID/<br/>├── 模板/<br/>└── 用戶文件/)]

    subgraph K8sCluster["☸️ Kubernetes 集群"]
        direction TB
        IngressController[🚪 Ingress NGINX 控制器<br/>流量路由]
        CertManager[🔒 Cert 管理器<br/>TLS 證書管理]

        subgraph ReplResources["📦 每個 REPL 的資源"]
            Deployment[🚀 部署<br/>REPL 容器實例]
            Service[🔗 服務<br/>內部網絡訪問]
            Ingress[🌍 入口<br/>外部訪問路由]
        end

        subgraph Pod["🏠 REPL Pod"]
            MainContainer[🐳 運行容器<br/>• WebSocket 服務器<br/>• 文件操作<br/>• PTY/終端訪問<br/>• 代碼執行]
            EphemeralContainer[⚡ 臨時容器<br/>文件同步回 S3<br/>🔄 清理過程]
        end

        Deployment --> Pod
        Service --> Pod
        Ingress --> Service
        IngressController --> Ingress
    end

    Core --> K8sCluster
    Core -.->|創建資源<br/>部署 → 服務 → 入口| ReplResources
    Web -.->|🔌 WebSocket 連接<br/>• 文件管理<br/>• 終端訪問<br/>• 即時協作| MainContainer
    Core -.->|📁 複製模板<br/>到用戶目錄| S3
    EphemeralContainer -.->|💾 同步文件回<br/>清理前| S3
    MainContainer -.->|📂 加載文件<br/>會話開始時| S3

🌀 會話生命週期

sequenceDiagram
    participant U as 用戶
    participant W as 前端網頁
    participant C as 核心服務
    participant K as Kubernetes
    participant S as S3 存儲
    participant R as 運行容器

    U->>W: 創建新 REPL
    W->>C: POST /repl/create
    C->>S: 創建用戶目錄<br/>複製模板文件

    U->>W: 啟動會話
    W->>C: POST /repl/start
    C->>K: 創建部署<br/>服務和入口
    K->>R: 初始化容器
    R->>S: 下載文件
    R->>W: WebSocket 連接

    Note over U,R: 開發會話激活
    U->>R: 通過 WebSocket 進行文件操作
    R->>R: 即時文件編輯

    U->>W: 關閉會話
    W->>C: POST /repl/stop
    C->>K: 注入臨時容器
    K->>S: 上傳修改後的文件
    C->>K: 刪除資源

🔩 關鍵組件

– 前端

• 基於 Next.js + Tailwind CSS 構建
• 支持 GitHub OAuth 登錄
• 提供文件樹、編輯器和終端的圖形用戶界面
• 包含用於與運行器交互的 WebSocket 鉤子

– 後端 API

• 採用 Go 語言編寫
• 處理用戶認證、S3 操作、Kubernetes 部署和清理
• 使用 Redis 進行 REPL 會話狀態跟蹤
• 📄 詳細架構和部署步驟請參閱 core/README.md

– REPL 運行時容器

• 輕量級 Go 服務器
• 提供以下功能的 WebSocket API：
  • 文件樹和文件內容訪問
  • 終端（PTY）會話
• 📄 事件列表和包內部詳情請參閱 runner/README.md

– Kubernetes 引導和 TLS

• 包含：
  • Ingress-NGINX 配置
  • cert-manager + Let’s Encrypt 實現自動 TLS
• 📄 完整設置說明請參閱 k8s/README.md

• 在創建 REPL 時複製的基礎文件夾（如 Node.js、Python）
• 特定語言的 Docker 化腳手架
• 📦 想添加自己的模板？請參閱 貢獻指南

🧱 基礎設施

• ☸️ 用於 REPL Pod 的 Kubernetes 集群
• 🔒 用於 TLS 的 Cert Manager + Let’s Encrypt
• 🗃️ 用於持久化的 S3 兼容存儲
• 🐳 用於運行時環境的 Docker 鏡像
• ⚙️ 用於內存會話跟蹤的 Redis

📦 部署流程

1. 用戶登錄並創建 REPL
2. core/ 將模板複製到 S3 上的 用戶名/REPL ID/ 目錄
3. core/ 在 Kubernetes 中部署 Pod、服務和入口
4. runner/ 通過 WebSocket 連接並提供文件系統和終端服務
5. 會話結束時：

• 臨時容器將更新後的文件上傳到 S3
• 清理所有 K8s 資源

💻 技術棧

📄 各組件文檔

📚 如需更深入的實現細節：

• – 後端 README.md
• – 運行器 WebSocket README.md
• – Kubernetes + TLS 設置
• – 前端 README.md

🧠 構建原因

“這個項目是我深入研究雲基礎設施、DevOps 和全棧工程的成果，它是一個實際應用的體現。” — Parth Kapoor

🌐 演示與鏈接

• 🧪 在線演示
• 🧑‍💻 個人主頁
• 🐙 GitHub 倉庫

🤝 貢獻

本項目正在積極開發中。如果你想貢獻模板、修復問題或添加功能，請從這裡開始 👉 CONTRIBUTING.md。歡迎提交拉取請求、提出建議和反饋！

📜 許可證

本項目採用 MIT 許可證。