📄 docs: Update readme

This commit is contained in:
Keith Solomon
2025-07-22 12:11:40 -05:00
parent 2f84569e60
commit 1185e35a1d
2 changed files with 81 additions and 2 deletions

View File

@@ -1,5 +1,82 @@
# Prompt Catalog # Prompt Catalog
## Overview & Purpose ## Overview
The Prompt Catalog is a centralized repository for prompts used in various applications, such as AI models or chatbots. It aims to provide a structured way to store, search, and categorize prompts for easy access and management. It will serve as a comprehensive and user-friendly catalog of prompts that can be easily searched, categorized, and tagged, enhancing the usability and discoverability of prompts for developers and users alike. The Prompt Catalog is a centralized, searchable repository for storing and managing prompts used in AI models, chatbots, or any generative application. It provides a structured way to organize, tag, search, and reuse prompts—streamlining prompt engineering for developers, teams, and enthusiasts.
## Features
- **Prompt Types**: Categorize prompts as `System` or `Task`
- **Tagging**: Add tags to describe and filter prompts
- **Search**: Keyword and full-text search with filter by type and tags
- **Metadata**: Each prompt includes:
- Title
- Description
- Tags
- Type
- Created/Last modified timestamps
- **Import/Export**: Import/export prompts via JSON files
- **AI Integration**: Suggest prompts using OpenAI, Together, or Ollama APIs (in progress)
- **Web UI**: Clean interface to view, edit, and manage prompts
- **Planned**:
- User auth and profiles
- Prompt favorites and contributions
- Ratings, version history, and sharing
- External API access
## Tech Stack
- **Frontend**: Astro + HTMX + Alpine.js (AHA Stack)
- **Backend**: Supabase (self-hosted)
- **Deployment**: Vercel or Netlify (frontend), Supabase (backend)
## Database Schema
### `prompts`
| Column | Type |
|---------------|------------|
| id | UUID |
| type | text |
| title | text |
| description | text |
| tags | array(text)|
| created_at | timestamp |
| updated_at | timestamp |
*Future tables: `users`, `user_prompts`*
## Development Roadmap
Development is organized into phases. For details, see `Development Checklist.md`.
### MVP Phases
1. **Planning & Setup**
2. **Database & Supabase API**
3. **Front-End UI** from [`Front End Interface.png`](notes/Front%20End%20Interface.png)
4. **Search & Tagging**
5. **AI Prompt Suggestions**
6. **Import/Export Functionality**
### Post-MVP Enhancements
- User login with Supabase Auth
- User-contributed prompts and favorites
- Ratings, version control, external API
- Shareable links and embeds
## Usage
To run locally:
```bash
npm install
npm run dev
```
You'll need a .env file with your Supabase credentials. See `supabase.env.example`.
## Contributing
Pull requests are welcome! Please keep contributions focused on core functionality and usability improvements.

2
supabase.env.example Normal file
View File

@@ -0,0 +1,2 @@
PUBLIC_SUPABASE_URL=<your Supabase url>
PUBLIC_SUPABASE_ANON_KEY=<your Supabase anon key>