hale-commenting-system 1.0.0

package/README.md

@@ -0,0 +1,222 @@
+# @apollo/commenting-system
+
+A reusable React commenting system with GitHub/GitLab integration and AI-powered summarization.
+
+## Features
+
+- 📌 **Visual Comment Pins** - Click anywhere to add comment threads
+- 🔄 **GitHub/GitLab Sync** - Two-way sync with issue trackers
+- 🤖 **AI Summarization** - Powered by DeepSeek R1 via MaaS
+- 📦 **Version Management** - Track comments across prototype versions
+- 🎨 **PatternFly UI** - Built with PatternFly React components
+- 🧙 **CLI Wizard** - Automated setup with `npx apollo-comments init`
+
+## Installation
+
+```bash
+npm install @apollo/commenting-system
+```
+
+## Quick Start
+
+Run the interactive setup wizard:
+
+```bash
+npx apollo-comments init
+```
+
+This will:
+- Detect your project type (React, PatternFly, Vite/Webpack)
+- Prompt for GitHub OAuth credentials
+- Generate serverless authentication functions
+- Create environment files (.env.local, .env.example)
+- Generate apollo-comments.config.json
+- Provide integration instructions
+
+## Manual Setup
+
+### 1. Basic Setup
+
+```tsx
+import {
+  CommentProvider,
+  VersionProvider,
+  GitHubAuthProvider,
+  CommentOverlay,
+  CommentDrawer
+} from '@apollo/commenting-system';
+import apolloCommentsConfig from './apollo-comments.config.json';
+import React from 'react';
+
+function App() {
+  const [selectedThreadId, setSelectedThreadId] = React.useState<string | null>(null);
+
+  return (
+    <GitHubAuthProvider config={apolloCommentsConfig}>
+      <VersionProvider>
+        <CommentProvider>
+          <CommentDrawer 
+            selectedThreadId={selectedThreadId} 
+            onThreadSelect={setSelectedThreadId}
+          >
+            <CommentOverlay 
+              selectedThreadId={selectedThreadId} 
+              onThreadSelect={setSelectedThreadId}
+            />
+            {/* Your app content */}
+          </CommentDrawer>
+        </CommentProvider>
+      </VersionProvider>
+    </GitHubAuthProvider>
+  );
+}
+```
+
+### 2. API Configuration
+
+The CLI generates serverless functions for GitHub OAuth. For manual setup, create:
+
+**Vercel**: `/api/github-oauth-login.ts` and `/api/github-oauth-callback.ts`
+**Netlify**: `/netlify/functions/github-oauth-login.ts` and `/netlify/functions/github-oauth-callback.ts`
+
+See the [manual setup guide](https://github.com/apollo/commenting-system/blob/main/docs/manual-setup.md) for templates.
+
+### 3. Environment Variables
+
+```env
+GITHUB_CLIENT_ID=your_github_client_id
+GITHUB_CLIENT_SECRET=your_github_client_secret
+GITHUB_OWNER=your_github_org
+GITHUB_REPO=your_repo_name
+
+# Vite (if using Vite)
+VITE_GITHUB_CLIENT_ID=your_github_client_id
+VITE_GITHUB_OWNER=your_github_org
+VITE_GITHUB_REPO=your_repo_name
+```
+
+## CLI Commands
+
+### Initialize
+
+```bash
+apollo-comments init
+```
+
+Options:
+- `-y, --yes` - Skip prompts and use defaults
+- `--platform <platform>` - Specify platform (vercel, netlify, manual)
+
+### Validate
+
+```bash
+apollo-comments validate
+```
+
+Checks your setup for:
+- Configuration files
+- Serverless functions
+- GitHub connectivity
+- Repository access
+
+## Components
+
+### Core Components
+
+- **CommentOverlay** - Renders comment pins on the page
+- **CommentDrawer** - Side panel for viewing/editing comments
+- **CommentPin** - Individual comment pin component
+- **AIAssistant** - AI chatbot toggle and panel
+
+### Providers
+
+- **CommentProvider** - Comment state and CRUD operations
+- **VersionProvider** - Version management
+- **GitHubAuthProvider** - GitHub authentication
+- **GitLabAuthProvider** - GitLab authentication  
+- **AIProvider** - AI chat state and API calls
+
+## Types
+
+```typescript
+import type { 
+  Comment, 
+  Thread, 
+  SyncStatus,
+  AIMessage, 
+  GitHubResult 
+} from '@apollo/commenting-system';
+```
+
+## Peer Dependencies
+
+- @patternfly/react-core: ^6.0.0
+- @patternfly/react-icons: ^6.0.0
+- @patternfly/chatbot: ^6.0.0
+- react: ^18.0.0
+- react-dom: ^18.0.0
+- react-router-dom: ^6.0.0 || ^7.0.0
+
+## Configuration File
+
+The CLI generates `apollo-comments.config.json`:
+
+```json
+{
+  "version": "1.0.0",
+  "platform": "vercel",
+  "github": {
+    "owner": "your-org",
+    "repo": "your-repo",
+    "clientId": "your-client-id"
+  },
+  "redirectUri": "https://your-domain.com/api/github-oauth-callback",
+  "features": {
+    "aiSummarization": true,
+    "versionTracking": true,
+    "gitlabIntegration": false
+  }
+}
+```
+
+## Development
+
+```bash
+# Install dependencies
+npm install
+
+# Build library and CLI
+npm run build
+
+# Watch mode (library only)
+npm run dev
+
+# Type check
+npm run type-check
+```
+
+## Testing the Package Locally
+
+```bash
+# In this package directory
+npm link
+
+# In your test project
+npm link @apollo/commenting-system
+apollo-comments init
+```
+
+## License
+
+MIT
+
+## Author
+
+Justin Hale
+
+## Support
+
+- [Documentation](https://github.com/apollo/commenting-system)
+- [Issues](https://github.com/apollo/commenting-system/issues)
+- [Discussions](https://github.com/apollo/commenting-system/discussions)
+