Spinai Agent Integration

🚀 SpinAI 應用程序

SpinAI 應用程序是一個基於 TypeScript 的項目，它集成了 OpenAI 及其他 AI 服務的強大功能，為用戶提供便捷、高效的 AI 應用體驗。

🚀 快速開始

SpinAI 應用程序能讓你輕鬆集成 OpenAI 和其他 AI 服務。以下是快速上手的步驟：

1. 確保你已滿足先決條件，包括 Node.js（v18 或更高版本）、npm 或 yarn、OpenAI API 密鑰以及 HubSpot 訪問令牌。
2. 按照安裝指南完成項目的克隆、依賴安裝和環境變量設置。
3. 選擇開發或生產模式，啟動相應的服務器。

✨ 主要特性

• 強大的 AI 驅動：運用 OpenAI 的 AI 驅動功能，為應用賦予智能能力。
• 高效集成：與 HubSpot 整合，實現數據的高效交互與管理。
• 現代開發環境：採用現代的 TypeScript 開發環境，提升開發效率和代碼質量。
• 穩定後端支持：使用 Express.js 搭建後端，確保應用的穩定性和性能。
• 靈活配置：基於環境的配置，方便在不同環境下部署和使用。

📦 安裝指南

克隆倉庫

git clone [your-repo-url]
cd my-spinai-app

安裝依賴項

npm install

設置環境變量

• 複製 .env.example 到 .env：

cp .env.example .env

• 用你的憑證編輯 .env：

OPENAI_API_KEY="your-openai-api-key"
HUBSPOT_ACCESS_TOKEN="your-hubspot-access-token"
SHARED_CONTACT_ID="your-shared-contact-id"

💻 使用示例

開發模式

運行開發服務器

npm run dev

此命令將啟動帶有熱重載功能的開發服務器，方便你進行代碼調試和開發。

構建生產版本

npm run build

該命令會將項目構建為適用於生產環境的版本。

啟動生產服務器

npm run start

此命令將啟動生產服務器，讓你的應用正式上線運行。

📚 詳細文檔

項目結構

my-spinai-app/
├── src/              # 源代碼目錄
├── .env              # 環境變量文件（從 .env.example 複製）
├── .env.example      # 示例環境變量文件
├── package.json      # 項目依賴和腳本
├── tsconfig.json     # TypeScript 配置
└── mcp-config.ts     # 模型上下文協議配置

可用腳本

• npm run dev：啟動開發服務器，帶有熱重載功能。
• npm run build：構建項目用於生產。
• npm run start：啟動生產服務器。
• npm run lint：運行 ESLint 進行代碼格式檢查。
• npm run check-types：檢查 TypeScript 類型。

環境變量

以下環境變量是必需的：

• OPENAI_API_KEY：你的 OpenAI API 密鑰。
• HUBSPOT_ACCESS_TOKEN：你的 HubSpot 訪問令牌。
• SHARED_CONTACT_ID：HubSpot 的共享聯繫人 ID。

🔧 技術細節

本項目使用了以下技術：

• TypeScript：提供類型檢查和現代 JavaScript 特性，增強代碼的可維護性。
• Node.js：作為服務器端運行環境，支持高效的網絡應用開發。
• Express.js：用於構建後端服務器，提供穩定的路由和中間件支持。
• OpenAI SDK：方便集成 OpenAI 的 AI 服務。
• HubSpot 集成：實現與 HubSpot 的數據交互和管理。
• ESLint：用於代碼格式檢查，確保代碼風格的一致性。

📄 許可證

此項目根據 MIT 許可證發佈，詳情請參閱 LICENSE 文件。

貢獻指南

[在此處添加貢獻指南（如有必要）]