diff --git a/README.md b/README.md index 620eeb87..5578fc24 100644 --- a/README.md +++ b/README.md @@ -3,11 +3,16 @@
[![GitHub stars](https://img.shields.io/github/stars/linshenkx/prompt-optimizer)](https://github.com/linshenkx/prompt-optimizer/stargazers) +![Chrome Web Store Users](https://img.shields.io/chrome-web-store/users/cakkkhboolfnadechdlgdcnjammejlna?style=flat&label=Chrome%20Users&link=https%3A%2F%2Fchromewebstore.google.com%2Fdetail%2F%25E6%258F%2590%25E7%25A4%25BA%25E8%25AF%258D%25E4%25BC%2598%25E5%258C%2596%25E5%2599%25A8%2Fcakkkhboolfnadechdlgdcnjammejlna) + [![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE) [![Docker Pulls](https://img.shields.io/docker/pulls/linshen/prompt-optimizer)](https://hub.docker.com/r/linshen/prompt-optimizer) +![GitHub forks](https://img.shields.io/github/forks/linshenkx/prompt-optimizer?style=flat) [![Deploy with Vercel](https://img.shields.io/badge/Vercel-indigo?style=flat&logo=vercel)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Flinshenkx%2Fprompt-optimizer) -[在线体验](https://prompt.always200.com) | [安装指南](#-快速开始) | [开发文档](dev.md) | [Chrome插件](https://chromewebstore.google.com/detail/prompt-optimizer/cakkkhboolfnadechdlgdcnjammejlna) +[在线体验](https://prompt.always200.com) | [安装指南](#快速开始) | [开发文档](dev.md) | [Chrome插件](https://chromewebstore.google.com/detail/prompt-optimizer/cakkkhboolfnadechdlgdcnjammejlna) + +[English](README_EN.md) | [中文](README.md)
@@ -108,7 +113,7 @@ pnpm dev:fresh # 完整重置并重新启动开发环境 - [x] Chrome插件发布 - [x] 自定义模型支持 - [x] 多模型支持优化 -- [ ] 国际化支持 +- [x] 国际化支持 详细的项目状态可查看 [项目状态文档](docs/project-status.md) @@ -138,6 +143,14 @@ pnpm dev:fresh # 完整重置并重新启动开发环境 4. 推送到分支 (`git push origin feature/AmazingFeature`) 5. 提交 Pull Request +## 👏 贡献者名单 + +感谢所有为项目做出贡献的开发者! + + + 贡献者 + + ## 📄 开源协议 本项目采用 [MIT](LICENSE) 协议开源。 diff --git a/README_EN.md b/README_EN.md new file mode 100644 index 00000000..5e4c38aa --- /dev/null +++ b/README_EN.md @@ -0,0 +1,166 @@ +# Prompt Optimizer 🚀 + +
+ +[![GitHub stars](https://img.shields.io/github/stars/linshenkx/prompt-optimizer)](https://github.com/linshenkx/prompt-optimizer/stargazers) +![Chrome Web Store Users](https://img.shields.io/chrome-web-store/users/cakkkhboolfnadechdlgdcnjammejlna?style=flat&label=Chrome%20Users&link=https%3A%2F%2Fchromewebstore.google.com%2Fdetail%2F%25E6%258F%2590%25E7%25A4%25BA%25E8%25AF%258D%25E4%25BC%2598%25E5%258C%2596%25E5%2599%25A8%2Fcakkkhboolfnadechdlgdcnjammejlna) + +[![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE) +[![Docker Pulls](https://img.shields.io/docker/pulls/linshen/prompt-optimizer)](https://hub.docker.com/r/linshen/prompt-optimizer) +![GitHub forks](https://img.shields.io/github/forks/linshenkx/prompt-optimizer?style=flat) +[![Deploy with Vercel](https://img.shields.io/badge/Vercel-indigo?style=flat&logo=vercel)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Flinshenkx%2Fprompt-optimizer) + +[Live Demo](https://prompt.always200.com) | [Installation](#quick-start) | [Development Docs](dev.md) | [Chrome Extension](https://chromewebstore.google.com/detail/prompt-optimizer/cakkkhboolfnadechdlgdcnjammejlna) + +[English](README_EN.md) | [中文](README.md) + +
+ +## 📖 Project Introduction + +Prompt Optimizer is a powerful AI prompt optimization tool that helps you write better AI prompts and improve the quality of AI outputs. It supports both web application and Chrome extension usage. + +### 🎥 Feature Demonstration + +
+ Feature Demonstration +
+ +## ✨ Core Features + +- 🎯 Intelligent Optimization: One-click prompt optimization with multi-round iterative improvements to enhance AI response accuracy +- 🔄 Comparison Testing: Real-time comparison between original and optimized prompts for intuitive demonstration of optimization effects +- 🔄 Multi-model Integration: Support for mainstream AI models including OpenAI, Gemini, DeepSeek, etc., to meet different needs +- 🔒 Secure Architecture: Pure client-side processing with direct data interaction with AI service providers, bypassing intermediate servers +- 💾 Privacy Protection: Local encrypted storage of history records and API keys to ensure data security +- 📱 Multi-platform Support: Available as both a web application and Chrome extension +- 🎨 User Experience: Clean and intuitive interface design with responsive layout and smooth interaction effects +- 🌐 Cross-domain Support: Edge Runtime proxy for cross-domain issues when deployed on Vercel (may trigger risk control from some providers) + +## 🚀 Quick Start + +### 1. Use Online Version (Recommended) + +1. Direct access: [https://prompt.always200.com](https://prompt.always200.com) +2. Or one-click deploy to your own Vercel: + [![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Flinshenkx%2Fprompt-optimizer) + +### 2. Install Chrome Extension +1. Install from Chrome Web Store (may not be the latest version due to approval delays): [Chrome Web Store](https://chromewebstore.google.com/detail/prompt-optimizer/cakkkhboolfnadechdlgdcnjammejlna) +2. Click the icon to open the Prompt Optimizer + +### 3. Docker Deployment +```bash +# Run container (default configuration) +docker run -d -p 80:80 --restart unless-stopped --name prompt-optimizer linshen/prompt-optimizer + +# Run container (with API key configuration) +docker run -d -p 80:80 \ + -e VITE_OPENAI_API_KEY=your_key \ + --restart unless-stopped \ + --name prompt-optimizer \ + linshen/prompt-optimizer +``` + +## ⚙️ API Key Configuration + +### Method 1: Via Interface (Recommended) +1. Click the "⚙️Settings" button in the upper right corner +2. Select the "Model Management" tab +3. Click on the model you need to configure (such as OpenAI, Gemini, DeepSeek, etc.) +4. Enter the corresponding API key in the configuration box +5. Click "Save" + +Supported models: +- OpenAI (gpt-3.5-turbo, gpt-4) +- Gemini (gemini-2.0-flash) +- DeepSeek (DeepSeek-V3) +- Custom API (OpenAI compatible interface) + +### Method 2: Via Environment Variables +Configure environment variables through the `-e` parameter when deploying with Docker: +```bash +-e VITE_OPENAI_API_KEY=your_key +-e VITE_GEMINI_API_KEY=your_key +-e VITE_DEEPSEEK_API_KEY=your_key +-e VITE_SILICONFLOW_API_KEY=your_key +-e VITE_CUSTOM_API_KEY=your_custom_api_key +-e VITE_CUSTOM_API_BASE_URL=your_custom_api_base_url +-e VITE_CUSTOM_API_MODEL=your_custom_model_name +``` + +## Local Development +For detailed documentation, see [Development Documentation](dev.md) + +```bash +# 1. Clone the project +git clone https://github.com/linshenkx/prompt-optimizer.git +cd prompt-optimizer + +# 2. Install dependencies +pnpm install + +# 3. Start development server +pnpm dev # Main development command: build core/ui and run web app +pnpm dev:web # Run web app only +pnpm dev:fresh # Complete reset and restart development environment +``` + +## 🗺️ Roadmap + +- [x] Basic feature development +- [x] Web application release +- [x] Chrome extension release +- [x] Custom model support +- [x] Multi-model support optimization +- [x] Internationalization support + +For detailed project status, see [Project Status Document](docs/project-status.md) + +## 📖 Related Documentation + +- [Documentation Index](docs/README.md) - Index of all documentation +- [Technical Development Guide](docs/technical-development-guide.md) - Technology stack and development specifications +- [Project Structure](docs/project-structure.md) - Detailed project structure description +- [Project Status](docs/project-status.md) - Current progress and plans +- [Product Requirements](docs/prd.md) - Product requirements document + +## Star History + + + + + + Star History Chart + + + +## 🤝 Contributing + +1. Fork the repository +2. Create a feature branch (`git checkout -b feature/AmazingFeature`) +3. Commit your changes (`git commit -m 'Add some feature'`) +4. Push to the branch (`git push origin feature/AmazingFeature`) +5. Open a Pull Request + +## 👏 Contributors + +Thanks to all the developers who have contributed to this project! + + + Contributors + + +## 📄 License + +This project is licensed under the [MIT](LICENSE) License. + +--- + +If this project is helpful to you, please consider giving it a Star ⭐️ + +## 👥 Contact Us + +- Submit an Issue +- Create a Pull Request +- Join the discussion group \ No newline at end of file