AI Prompt Keeper

A full-stack web application for storing, organizing, and managing AI prompts built with Go (Gin framework) and React (TypeScript + Vite). This project provides a comprehensive solution for AI prompt management with categories, tags, search functionality, sharing capabilities, and user authentication.

🚀 Features

Core Functionality

• Prompt Management - Create, read, update, and delete AI prompts
• Organization - Categorize prompts with custom categories and tags
• Search & Discovery - Powerful search functionality with filters
• Sharing - Share prompts with other users or make them public
• Version Control - Track prompt history and versions
• Import/Export - Backup and migrate prompt collections

Authentication & Security

• JWT Authentication - Secure token-based authentication
• OAuth Integration - Social login with Google and GitHub
• Role-based Access Control - Admin and user roles
• Protected Routes - Secure access to user data

Backend (Go)

• RESTful API - Clean API design with Gin framework
• Database Integration - PostgreSQL with migrations
• Middleware Support - Authentication and CORS middleware
• Environment Configuration - Flexible config management

Frontend (React)

• Modern React - Built with React 18 and TypeScript
• Vite Build Tool - Fast development and build process
• Ant Design - Enterprise-grade UI design language and components
• React Query - Powerful data fetching and caching
• React Router - Client-side routing
• Responsive Design - Mobile-first responsive interface

🛠️ Tech Stack

Backend

• Language: Go 1.23+
• Framework: Gin Web Framework
• Database: PostgreSQL
• ORM: SQLx
• Authentication: JWT with golang-jwt
• Configuration: Viper/godotenv
• CORS: gin-contrib/cors

Frontend

• Language: TypeScript
• Framework: React 18
• Build Tool: Vite
• UI Library: Ant Design (antd)
• HTTP Client: Axios
• State Management: React Query
• Routing: React Router DOM

📋 Prerequisites

• Go 1.23 or higher
• Node.js 18+ and npm/yarn
• PostgreSQL database
• Git

🔧 Installation

1. Clone the repository

git clone https://github.com/congdv/keeperprompt.git
cd keeperprompt

2. Backend Setup

Install Go dependencies

go mod download

Set up environment variables

Create a .env file in the root directory:

# Database
DB_HOST=localhost
DB_PORT=5432
DB_USER=your_db_user
DB_PASSWORD=your_db_password
DB_NAME=keeper_prompt_db
DB_SSL_MODE=disable

# JWT
JWT_SECRET=your-super-secret-jwt-key
JWT_EXPIRY=24h

# OAuth (optional)
GOOGLE_CLIENT_ID=your_google_client_id
GOOGLE_CLIENT_SECRET=your_google_client_secret
GITHUB_CLIENT_ID=your_github_client_id
GITHUB_CLIENT_SECRET=your_github_client_secret

# Server
PORT=8080
GIN_MODE=debug

Run database migrations

# Create database
createdb keeper_prompt_db

# Run migrations
psql -d keeper_prompt_db -f migrations/0001_init.sql

3. Frontend Setup

Navigate to webapp directory

cd webapp

Install Node.js dependencies

npm install
# or
yarn install

🚀 Running the Application

Start the Backend Server

# From the root directory
go run cmd/api/main.go

The API server will start on http://localhost:8080

Start the Frontend Development Server

# From the webapp directory
cd webapp
npm run dev
# or
yarn dev

The React app will start on http://localhost:5173

📁 Project Structure

├── cmd/
│   └── api/
│       └── main.go              # Application entry point
├── internal/
│   ├── config/
│   │   └── config.go            # Configuration management
│   ├── database/
│   │   └── db.go                # Database connection
│   ├── http/
│   │   ├── handlers/            # HTTP request handlers
│   │   └── middleware/          # HTTP middleware
│   ├── models/                  # Data models
│   ├── repository/              # Data access layer
│   └── services/                # Business logic layer
├── migrations/                  # Database migrations
├── webapp/
│   ├── src/
│   │   ├── components/          # React components
│   │   ├── context/             # React contexts
│   │   ├── lib/                 # Utility libraries
│   │   └── pages/               # Page components
│   ├── package.json
│   └── vite.config.ts
├── go.mod
├── go.sum
└── README.md

🔗 API Endpoints

Authentication

• POST /api/auth/register - User registration
• POST /api/auth/login - User login
• POST /api/auth/logout - User logout
• GET /api/auth/me - Get current user
• POST /api/auth/refresh - Refresh JWT token

OAuth

• GET /api/auth/oauth/google - Google OAuth login
• GET /api/auth/oauth/github - GitHub OAuth login
• GET /api/auth/oauth/callback - OAuth callback handler

Prompts (Protected)

• GET /api/prompts - Get user's prompts
• POST /api/prompts - Create new prompt
• GET /api/prompts/:id - Get prompt by ID
• PUT /api/prompts/:id - Update prompt
• DELETE /api/prompts/:id - Delete prompt
• GET /api/prompts/search - Search prompts

Categories (Protected)

• GET /api/categories - Get user's categories
• POST /api/categories - Create new category
• PUT /api/categories/:id - Update category
• DELETE /api/categories/:id - Delete category

Tags (Protected)

• GET /api/tags - Get user's tags
• POST /api/tags - Create new tag
• PUT /api/tags/:id - Update tag
• DELETE /api/tags/:id - Delete tag

Users (Protected)

• GET /api/users - Get users (admin only)
• GET /api/users/:id - Get user by ID
• PUT /api/users/:id - Update user
• DELETE /api/users/:id - Delete user (admin only)

🔒 Environment Variables

Variable	Description	Required
DB_HOST	Database host	Yes
DB_PORT	Database port	Yes
DB_USER	Database username	Yes
DB_PASSWORD	Database password	Yes
DB_NAME	Database name	Yes
JWT_SECRET	JWT signing secret	Yes
JWT_EXPIRY	JWT token expiry duration	Yes
PORT	Server port	No (default: 8080)
GIN_MODE	Gin mode (debug/release)	No
GOOGLE_CLIENT_ID	Google OAuth client ID	No
GOOGLE_CLIENT_SECRET	Google OAuth client secret	No
GITHUB_CLIENT_ID	GitHub OAuth client ID	No
GITHUB_CLIENT_SECRET	GitHub OAuth client secret	No

📱 Usage

Managing Prompts

1. Create Prompts: Add new AI prompts with titles, descriptions, and content
2. Organize: Assign categories and tags to your prompts for better organization
3. Search: Use the search functionality to quickly find prompts by keywords, categories, or tags
4. Share: Make prompts public or share them with specific users
5. Version Control: Track changes and maintain different versions of your prompts

Categories and Tags

• Create custom categories to organize prompts by topic or use case
• Use tags for more granular organization and cross-category labeling
• Filter and search prompts by categories and tags

Import/Export

• Export your prompt collection for backup purposes
• Import prompts from other sources or migrate between accounts

🧪 Testing

Backend Tests

go test ./...

Frontend Tests

cd webapp
npm test
# or
yarn test

docker build -t keeper-prompt .
docker run --env-file .env --network host keeper-prompt

🏗️ Building for Production

Backend

go build -o bin/api cmd/api/main.go

Frontend

cd webapp
npm run build
# or
yarn build

📝 License

This project is licensed under the MIT License - see the LICENSE file for details.

🤝 Contributing

1. Fork the repository
2. Create your feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'Add some amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a Pull Request

📞 Support

If you have any questions or need help, please open an issue on GitHub.

🙏 Acknowledgments

• Gin Web Framework
• React
• Ant Design
• Vite
• React Query
• PostgreSQL

---

AI Prompt Keeper - Organize, manage, and share your AI prompts efficiently.