feat(docs): add SELF-HOSTING.md with instructions for deploying private prompt library

2026-02-12 15:52:47 +00:00 · 2025-12-12 04:02:15 +03:00
parent 8501c9b313
commit dee7882a49
2 changed files with 156 additions and 0 deletions
--- a/README.md
+++ b/README.md
@@ -32,6 +32,8 @@ In this repository, you will find a variety of prompts that can be used with Cha

 To get started, simply clone this repository and use the prompts in the README.md file as input for your preferred AI chat model. You can also use the prompts in this file as inspiration for creating your own.

+Want to deploy your own private prompt library? Check out our [Self-Hosting Guide](SELF-HOSTING.md) for instructions on setting up your own instance with customizable branding, themes, and authentication.
+
 We hope you find these prompts useful and have fun exploring AI chat models!

 **[View on prompts.chat](https://prompts.chat)**
--- a/SELF-HOSTING.md
+++ b/SELF-HOSTING.md
@@ -0,0 +1,154 @@
+# Self-Hosting Guide
+
+## Capabilities
+
+- **Curated Prompt Library** — Access 100+ high-quality, community-tested prompts for ChatGPT, Claude, Gemini, Llama, Mistral, and other AI models
+- **Discover & Browse** — Explore prompts by categories, tags, or AI-powered semantic search
+- **Create & Share Prompts** — Submit your own prompts with support for text, structured (JSON/YAML), and media-enhanced formats
+- **Version Control** — Track prompt changes with built-in versioning and change request system (similar to PRs)
+- **Personalized Feed** — Subscribe to categories and get a curated feed of prompts matching your interests
+- **Private Prompts** — Keep your prompts private or share them with the community
+- **Voting & Leaderboard** — Upvote prompts and discover the most popular ones via PromptMasters leaderboard
+- **Multi-language Support** — Available in English, Spanish, Japanese, Turkish, and Chinese
+
+## Benefits
+
+- **Unlock AI Potential:** Stop struggling with prompt engineering — use battle-tested prompts from 139k+ GitHub stars community
+- **Save Time:** Copy prompts with one click, customize variables inline, and use them instantly in any AI chat
+- **Community-Driven Quality:** Every prompt is curated and refined by the community through change requests and voting
+- **Self-Hostable:** Deploy your own white-labeled prompt library for your team or organization with customizable branding, themes, and authentication
+- **CC0 Licensed:** All prompts are public domain — use them freely for any purpose, commercial or personal
+
+## Getting Started
+
+**Requirements:**
+- **Plan:** Free and open-source (CC0 license)
+- **User Permissions:** No account needed to browse; sign in via GitHub/Google to create & save prompts
+- **Availability:** Generally Available at [prompts.chat](https://prompts.chat)
+
+---
+
+This guide explains how to deploy **prompts.chat** on your own private server for enhanced privacy and customization.
+
+## Prerequisites
+
+- **Node.js** 18+ 
+- **PostgreSQL** database
+- **npm** or **yarn**
+
+## Environment Variables
+
+Create a `.env` file based on `.env.example`:
+
+```bash
+# Database
+DATABASE_URL="postgresql://user:password@localhost:5432/prompts"
+
+# Authentication (choose one provider)
+# GitHub OAuth
+AUTH_GITHUB_ID="your-github-client-id"
+AUTH_GITHUB_SECRET="your-github-client-secret"
+
+# Or Google OAuth
+AUTH_GOOGLE_ID="your-google-client-id"
+AUTH_GOOGLE_SECRET="your-google-client-secret"
+
+# NextAuth
+AUTH_SECRET="generate-a-random-secret"
+
+# Optional: AI-powered semantic search
+OPENAI_API_KEY="your-openai-api-key"
+```
+
+## Installation
+
+1. **Clone the repository**
+   ```bash
+   git clone https://github.com/f/awesome-chatgpt-prompts.git
+   cd awesome-chatgpt-prompts
+   ```
+
+2. **Install dependencies**
+   ```bash
+   npm install
+   ```
+
+3. **Configure your environment**
+   ```bash
+   cp .env.example .env
+   # Edit .env with your database and auth credentials
+   ```
+
+4. **Run database migrations**
+   ```bash
+   npm run db:migrate
+   ```
+
+5. **Seed initial data** (optional)
+   ```bash
+   npm run db:seed
+   ```
+
+6. **Start the development server**
+   ```bash
+   npm run dev
+   ```
+
+7. **Build for production**
+   ```bash
+   npm run build
+   npm run start
+   ```
+
+## Configuration
+
+Customize your instance by editing `prompts.config.ts`:
+
+```typescript
+export default defineConfig({
+  // Branding
+  branding: {
+    name: "Your Prompt Library",
+    logo: "/your-logo.svg",
+    description: "Your custom description",
+  },
+
+  // Theme
+  theme: {
+    radius: "sm",        // "none" | "sm" | "md" | "lg"
+    variant: "default",  // "flat" | "default" | "brutal"
+    colors: {
+      primary: "#6366f1",
+    },
+  },
+
+  // Authentication
+  auth: {
+    provider: "github",  // "credentials" | "github" | "google" | "azure"
+    allowRegistration: true,
+  },
+
+  // Features
+  features: {
+    privatePrompts: true,
+    changeRequests: true,
+    categories: true,
+    tags: true,
+    aiSearch: false,  // Requires OPENAI_API_KEY
+  },
+
+  // Internationalization
+  i18n: {
+    locales: ["en", "es", "ja", "tr", "zh"],
+    defaultLocale: "en",
+  },
+});
+```
+
+## Docker Deployment
+
+Coming soon.
+
+## Support
+
+For issues and questions, please open a [GitHub Issue](https://github.com/f/awesome-chatgpt-prompts/issues).