Open Prompts

📖 Introduction

Open Prompts is a community-driven platform designed to help users harness the full potential of Large Language Models (LLMs) like ChatGPT, Claude, and Gemini. It provides a structured environment to create, test, version, and share high-quality prompts.

Whether you are a prompt engineer, a developer, or an AI enthusiast, Open Prompts manages your prompt library with the same rigor as code—featuring version control, tagging, and collaboration tools.

✨ Features

• 📚 Centralized Prompt Library: Store and organize all your AI prompts in one place.
• 🔄 Version Control: Track changes to your prompts, fork existing templates, and maintain a history of iterations.
• 🌍 Multi-language Support: Native support for Internationalization (English & Chinese). Switching the UI language only changes display labels — prompt templates are shared across languages.
• 🎨 Modern UI/UX: Custom Aurora design system with light & dark themes, fully responsive and accessible.
• 📱 One-Click Sharing: Share your best prompts with the community or keep them private.
• 🔐 Secure Authentication: Robust user management and authentication system (JWT).
• 🔑 API Keys & SDKs: Issue API keys for programmatic access and integrate via the official Python SDK.

🛠 Tech Stack

Frontend

• Framework: React 18
• State Management: Redux Toolkit
• UI System: Custom "Aurora" design system (SASS, light & dark themes)
• HTTP Client: Axios
• i18n: i18next

Backend

• Language: Go (Golang) 1.25+
• API Protocol: gRPC & RESTful JSON
• Database: PostgreSQL
• Caching: Redis
• Auth: JWT (JSON Web Tokens)

Python SDK

• Package: openprompts (Python 3.7+)
• Docs: python-sdk/README.md

Infrastructure

• Containerization: Docker & Docker Compose
• Orchestration: Kubernetes (Helm chart)
• Reverse Proxy: Nginx
• CI/CD: Github Actions

🚀 Getting Started

Follow these steps to set up the project locally.

Prerequisites

• Docker & Docker Compose
• Node.js (v18+) - If running frontend locally
• Go (v1.25+) - If running backend locally

Installation

1. Clone the repository

git clone https://github.com/open-prompts/open-prompts.git
   cd open-prompts

1. Run with Docker Compose (Recommended)

cd deployment
   docker-compose up -d

- Frontend: http://localhost:3000 - Backend API: http://localhost:3000/api (Proxied) or http://localhost:8080 (Direct)

1. Deploy on Kubernetes (Helm)

helm install open-prompts deployment/chart/open-prompts

1. Manual Development Setup

docker-compose up -d postgres redis

Backend:

cd backend
   go mod download
   # Run the server
   go run cmd/server/main.go

Frontend:

cd frontend
   npm install
   npm start

🤝 Contributing

We welcome contributions from the community! Whether it's fixing bugs, improving documentation, or adding new features.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'feat: add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

Commit Message Convention

We follow the Conventional Commits specification. This leads to more readable messages that are easy to follow when looking through the project history.

Format: ():

Examples:

• feat(auth): support google oauth login
• fix(ui): fix mobile layout overflow issue
• docs: update readme with manual setup guide
• chore: update dependencies

• feat: A new feature
• fix: A bug fix
• docs: Documentation only changes
• style: Changes that do not affect the meaning of the code (white-space, formatting, etc)
• refactor: A code change that neither fixes a bug nor adds a feature
• perf: A code change that improves performance
• test: Adding missing tests or correcting existing tests
• chore: Changes to the build process or auxiliary tools and libraries such as documentation generation

📄 License

Distributed under the MIT License. See LICENSE for more information.

Star History