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 文件。

贡献指南

[在此处添加贡献指南（如有必要）]