linshen 5dac3a33e6 docs: Revamp README with comprehensive project overview and enhanced documentation
- Update README with more engaging and informative content
- Add emoji icons to improve readability
- Restructure sections for better navigation
- Include project structure, development commands, and technology stack
- Enhance deployment and configuration instructions
- Add roadmap and contribution guidelines
- Improve overall presentation and clarity
2025-02-15 22:10:51 +08:00

Prompt Optimizer (提示词优化器) 🚀

部署到 Vercel

一个好用的提示词优化工具,帮助你优化和改进AI提示词,支持Web应用和Chrome插件。

📌 在线体验

项目截图

✨ 核心特性

  • 🎯 智能优化:基于LangChain的提示词优化引擎
  • 🔄 多模型支持:集成Gemini Pro、DeepSeek、OpenAI等多个模型
  • 💾 本地存储:安全的历史记录和设置管理
  • 📱 跨平台:支持Web应用和Chrome插件
  • 🎨 优雅界面:响应式设计 + 流畅动画
  • 🛡️ 安全可靠:API密钥加密存储

🚀 快速开始

环境要求

  • Node.js >= 16
  • pnpm >= 8

安装步骤

# 1. 克隆项目
git clone https://github.com/linshenkx/prompt-optimizer.git
cd prompt-optimizer

# 2. 安装依赖
pnpm install

# 3. 启动开发服务
pnpm dev:web    # Web版
pnpm dev:ext    # 插件版

环境配置(可以在运行时配置)

在 packages/web 目录下创建 .env.local 文件:

# Gemini API配置
VITE_GEMINI_API_KEY=your_gemini_api_key

# DeepSeek API配置
VITE_DEEPSEEK_API_KEY=your_deepseek_api_key

# 自定义API配置(可选)
VITE_CUSTOM_API_KEY=your_custom_api_key
VITE_CUSTOM_API_BASE_URL=your_custom_api_base_url
VITE_CUSTOM_API_MODEL=your_custom_model_name

📦 项目结构

prompt-optimizer/
├── packages/                # 多包工程
│   ├── core/               # 核心功能
│   ├── ui/                 # UI组件库
│   ├── web/               # Web应用
│   └── extension/         # Chrome插件
├── docs/                  # 项目文档
└── tests/                 # 测试用例

🛠️ 开发命令

# === 开发环境 ===
pnpm dev:core              # 开发核心包
pnpm dev:ui               # 开发UI库
pnpm dev:web              # 开发Web版
pnpm dev:ext              # 开发插件版

# === 构建打包 ===
pnpm build:core           # 构建核心包
pnpm build:ui            # 构建UI库
pnpm build:web           # 构建Web版
pnpm build:ext           # 构建插件版

# === 测试相关 ===
pnpm test                # 运行所有测试
pnpm test:core           # 测试核心包
pnpm test:ui            # 测试UI库

📚 技术栈

  • 🔧 核心框架

    • TypeScript 5.x
    • Vue 3.4.x
    • Vite 5.x
    • LangChain
  • 🎨 UI框架

    • TailwindCSS 3.4.x
    • Vue组件库
  • 📦 工程化

    • pnpm
    • Vitest
    • ESLint
    • Prettier

🗺️ 开发路线

  • 基础功能开发
  • Web应用发布
  • Chrome插件发布
  • 更多模型支持
  • 提示词模板市场
  • 国际化支持

📖 相关文档

🤝 参与贡献

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

📄 开源协议

本项目采用 MIT 协议 - 详见 LICENSE 文件

👥 联系我们

  • 提交 Issue
  • 发起 Pull Request
  • 加入讨论组
S
Description
An AI prompt optimizer for writing better prompts and getting better AI results.
https://prompt.always200.com
Readme AGPL-3.0
45 MiB
0 Stars 1 Watchers 0 Forks
Languages
TypeScript 71.9%
Vue 21.6%
JavaScript 5.2%
CSS 1.1%