deepsitegroq / README.md
R-Kentaren's picture
Upload folder using huggingface_hub
d5df1b1 verified

DeepSite 🚀

DeepSite 是一个基于 React + TypeScript + Vite 构建的智能应用生成器,集成了 Monaco Editor 和 Groq,提供强大的代码编辑和 AI 辅助功能,现在支持构建全栈网站,并使用 Groq 的 openai/gpt-oss-20b 模型。

技术栈 💻

  • 前端框架: React 19
  • 开发语言: TypeScript 5.7
  • 构建工具: Vite 6
  • UI 框架: Tailwind CSS 4
  • 代码编辑器: Monaco Editor
  • AI 集成: Groq API (使用 openai/gpt-oss-20b 模型)
  • 其他特性:
    • React Speech Recognition
    • React Markdown
    • React Toastify

快速开始 🚀

环境要求

  • Node.js >= 16
  • npm 或 yarn
  • Docker(可选,用于容器化部署)

本地开发

  1. 克隆仓库:
git clone https://github.com/BF667/DeepSite-groq deepsite 
cd deepsite
  1. 安装依赖:
npm install
  1. 配置环境变量:
cp .env.example .env
# 编辑 .env 文件,填入必要的配置信息
  1. 启动开发服务器:
npm run dev
  1. 构建生产版本:
npm run build

Docker 启动 🐳

构建镜像

docker build -t my-deepsite .

启动容器

docker run -d -p 5173:5173 \

  my-deepsite

使用示例

如果您想使用不同的端口(例如 8080),可以这样配置:

docker run -d -p 8080:8080 \
  -e APP_PORT=8080 \
  -e GROQ_BASE_URL=https://api.groq.com/openai/v1/chat/completions \
  -e GTOQ_API_KEY=ghp_xxxxxxxx \
  -e GROQ_MODEL=openai/gpt-oss-20b \
  my-deepsite

注意事项

  • 确保 Docker 已正确安装并运行。
  • 构建镜像前,确保当前目录包含有效的 Dockerfile。
  • 请替换 sk-or-v1-xxxxx 为您的实际 API 密钥。
  • 可根据需要调整端口映射和环境变量。

环境变量可选参数 ⚙️

  • GROQ_BASE_URL: API 的基础 URL(必填)
  • GROQ_API_KEY: API 密钥(必填)
  • GROQ_MODEL: 模型名称(必填)
  • APP_PORT: 应用端口,默认为 5173(可选)

项目结构 📁

deepsite/
├── src/
│   ├── components/     # React 组件
│   ├── config/        # 配置文件
│   ├── assets/        # 静态资源
│   └── main.tsx       # 应用入口
├── services/          # 后端服务
├── middlewares/       # Express 中间件
├── utils/            # 工具函数
├── public/           # 公共资源
└── dist/             # 构建输出目录

开发命令 ⌨️

  • npm run dev - 启动开发服务器
  • npm run build - 构建生产版本
  • npm run preview - 预览生产构建
  • npm run lint - 运行 ESLint 检查
  • npm start - 启动生产服务器

环境变量配置 ⚙️

.env 文件中配置以下环境变量:

VITE_APP_TITLE=DeepSite
GRPQ_API_KEY=your_api_key
PORT=5173

贡献指南 🤝

  1. Fork 本仓库
  2. 创建特性分支 (git checkout -b feature/amazing-feature)
  3. 提交更改 (git commit -m 'Add some amazing feature')
  4. 推送到分支 (git push origin feature/amazing-feature)
  5. 创建 Pull Request