Update README.md

Author: tqmsh

README.md

@@ -1,311 +1,138 @@
-# 🚀 Hackd - AI-Powered Hacker Matching Platform
-
-> **Winner of Hack the North 2024** - *Find the perfect hacker for every situation*
-
-Hackd breaks the stigma of cold outreach by connecting you directly with top tech talent using AI-powered analysis of GitHub profiles, tech stacks, and collaboration patterns.
+# Hackd - Hacker Matching Platform
 
 [![Deploy with Defang](https://defang.io/deploy-with-defang.png)](https://portal.defang.dev/redirect?url=https%3A%2F%2Fgithub.com%2Fnew%3Ftemplate_name%3Dhackd-template%26template_owner%3DHackTheNorthTeam)
 
-## 🎯 What is Hackd?
+## Overview
 
-**The Problem**: Finding teammates at hackathons is stressful. The Hack the North Slack had 1,710 members in the "looking for teammates" channel, and taking the leap to message someone when you're a solo hacker can be terrifying.
+**Problem**: Finding teammates at hackathons is difficult. Slack channels get crowded and reaching out is awkward.
 
-**Our Solution**: Hackd analyzes GitHub profiles to understand what kind of coder you are, performs sentiment analysis to identify collaboration patterns, and uses AI to match you with the perfect teammates or candidates.
+**Solution**: Hackd analyzes GitHub profiles and matches hackers using sentiment and code analysis.
 
-### 🌟 Key Features
+## Features
 
-- **🔍 GitHub Profile Analysis**: Deep analysis of coding patterns, tech stacks, and project complexity
-- **🤖 AI-Powered Matching**: Uses Cohere AI for intelligent pairing based on complementary skills
-- **💼 Recruiter Dashboard**: Helps recruiters find top talent at hackathons
-- **📊 Collaboration Scoring**: Analyzes code comments, PR activity, and teamwork patterns
-- **🎨 Beautiful UI**: Modern React interface with smooth animations and responsive design
+- GitHub profile and coding pattern analysis
+- AI-powered matching using Cohere
+- Recruiter dashboard
+- Collaboration scoring
+- Clean React interface
 
-## 🏗️ Architecture
+## Architecture
 
 ```
 hackd/
-├── backend/                    # Python API Services
-│   ├── api/                   # Flask REST API
-│   │   └── main.py           # Main API server
-│   ├── github-analyzer/       # GitHub profile analysis
-│   │   └── github_analyzer.py # Core analysis engine
-│   ├── matching/              # AI matching engine
-│   │   └── matcher.py        # Cohere-powered matching
-│   └── requirements.txt       # Python dependencies
-│
-├── frontend/hackd-web/        # Next.js Frontend
-│   ├── app/                  # Next.js 14 app router
-│   │   ├── matching/         # User matching interface
-│   │   ├── recruiting/       # Recruiter dashboard
-│   │   └── hacker/          # Hacker profile forms
-│   ├── convex/              # Convex database & auth
-│   └── lib/api.ts           # Backend API client
-│
-└── config/                   # Configuration & deployment
-    └── docker-compose.yml    # Full-stack deployment
+├── backend/
+│   ├── api/main.py
+│   ├── github-analyzer/github_analyzer.py
+│   ├── matching/matcher.py
+│   └── requirements.txt
+├── frontend/hackd-web/
+│   ├── app/{matching,recruiting,hacker}/
+│   ├── convex/
+│   └── lib/api.ts
+└── config/docker-compose.yml
 ```
 
-## 🚀 Quick Start
+## Quick Start
 
 ### Prerequisites
 
-- **Node.js** 18+ and **npm**
-- **Python** 3.11+
-- **Git**
-- **GitHub Personal Access Token**
-- **Cohere API Key**
+- Node.js 18+
+- Python 3.11+
+- Git
+- GitHub Personal Access Token
+- Cohere API Key
 
-### 1. Clone & Setup
+### Setup
 
 ```bash
 git clone https://github.com/your-username/hackd.git
 cd hackd
 
-# Install backend dependencies
+# Backend
 cd backend
 pip install -r requirements.txt
 
-# Install frontend dependencies
+# Frontend
 cd ../frontend/hackd-web
 npm install
 ```
 
-### 2. Environment Configuration
+### Configuration
+
+#### Backend
 
-#### Backend Configuration
 ```bash
-cd backend
 cp .env.example .env
-# Edit .env with your API keys
+# Edit with keys
 ```
 
-#### Frontend Configuration
+#### Frontend
+
 ```bash
-cd frontend/hackd-web
 cp .env.local.example .env.local
-# Edit .env.local with your Convex & API settings
+# Edit with keys
 ```
 
-### 3. Required API Keys
+### API Keys Needed
 
-| Service | Purpose | How to Get |
-|---------|---------|------------|
-| **GitHub Token** | Profile analysis | [GitHub Settings → Developer settings → Personal access tokens](https://github.com/settings/tokens) |
-| **Cohere API Key** | AI matching & sentiment analysis | [Cohere Dashboard](https://dashboard.cohere.ai/) |
-| **Convex** | Database & authentication | [Convex Dashboard](https://dashboard.convex.dev/) |
+| Service | Use |
+|---------|-----|
+| GitHub  | Profile analysis |
+| Cohere  | Matching |
+| Convex  | Auth and DB |
 
-### 4. Run the Application
+### Run
 
-#### Option A: Development (Recommended)
+**Dev Mode**
 
 ```bash
-# Terminal 1: Start backend API
+# Terminal 1
 cd backend
 python api/main.py
 
-# Terminal 2: Start frontend
+# Terminal 2
 cd frontend/hackd-web
 npm run dev
 ```
 
-#### Option B: Docker Compose
+**Docker**
 
 ```bash
 cd config
 docker-compose up --build
 ```
 
-Visit: **http://localhost:3000** 🎉
+Access at `http://localhost:3000`
 
-## 🔧 API Endpoints
+## API Endpoints
 
-| Endpoint | Method | Purpose |
-|----------|--------|---------|
-| `/health` | GET | Service health check |
-| `/api/analyze-github` | POST | Analyze GitHub profile |
-| `/api/match-users` | POST | Find matching users |
-| `/api/analyze-job-description` | POST | Parse job requirements |
-| `/api/analyze-sentiment` | POST | Sentiment analysis |
+| Endpoint | Method | Description |
+|----------|--------|-------------|
+| `/health` | GET | Health check |
+| `/api/analyze-github` | POST | GitHub profile analysis |
+| `/api/match-users` | POST | Match hackers |
+| `/api/analyze-job-description` | POST | Job parsing |
+| `/api/analyze-sentiment` | POST | Sentiment |
 
-### Example Usage
+### Example
 
-```javascript
-// Analyze a GitHub profile
-const response = await fetch('http://localhost:5000/api/analyze-github', {
+```js
+const res = await fetch('http://localhost:5000/api/analyze-github', {
   method: 'POST',
   headers: { 'Content-Type': 'application/json' },
   body: JSON.stringify({ username: 'octocat' })
 });
-
-const profile = await response.json();
-console.log(profile.top_technologies); // ['JavaScript', 'Python', 'React']
+const data = await res.json();
+console.log(data.top_technologies);
 ```
 
-## 🧠 AI Matching Algorithm
-
-Our matching algorithm combines multiple factors: 
+## Matching Logic
 
 ```python
-# Core matching logic
 match_score = (
     tech_complementarity * 0.4 +
     experience_compatibility * 0.3 +
     collaboration_compatibility * 0.2 +
     activity_level * 0.1
 )
 ```
-
-## 🎨 Frontend Features
-
-### 🏠 Landing Page
-- Clean, modern design with animations
-- GitHub OAuth integration
-- Responsive layout
-
-### 🔍 Matching Interface
-- Interactive user cards with flip animations
-- Real-time skill visualization with pie charts
-- Liquid-fill progress bars for aptitude scores
-
-### 💼 Recruiter Dashboard
-- Job description analysis
-- Candidate ranking system
-- Sentiment analysis of job posts
-
-### 💬 Chat System
-- Real-time messaging with Convex
-- Team formation tools
-- Collaboration tracking
-
-## 🔒 Security & Best Practices
-
-- ✅ **No hardcoded secrets** - All API keys via environment variables
-- ✅ **Input validation** - Comprehensive request validation
-- ✅ **Error handling** - Graceful degradation and user feedback
-- ✅ **Rate limiting** - API request throttling
-- ✅ **CORS configured** - Secure cross-origin requests
-- ✅ **Health checks** - Service monitoring endpoints
-
-## 🧪 Testing
-
-```bash
-# Backend tests
-cd backend
-pytest
-
-# Frontend tests  
-cd frontend/hackd-web
-npm test
-
-# Integration tests
-npm run test:e2e
-```
-
-## 🚀 Deployment
-
-### Defang (Recommended)
-```bash
-# Install Defang CLI
-brew install DefangLabs/defang/defang
-
-# Login to Defang
-defang login
-
-# Deploy the application
-defang compose up
-```
-
-### Manual Deployment
-1. **Backend**: Deploy Flask API to Railway, Render, or AWS
-2. **Frontend**: Deploy Next.js to Vercel or Netlify
-3. **Database**: Convex handles database deployment
-
-### Environment Variables for Production
-
-Make sure to set these in your deployment environment:
-
-**Backend:**
-- `GITHUB_TOKEN` - Your GitHub personal access token
-- `COHERE_API_KEY` - Your Cohere API key
-- `FLASK_ENV=production`
-
-**Frontend:**
-- `NEXT_PUBLIC_CONVEX_URL` - Your Convex deployment URL
-- `NEXT_PUBLIC_API_URL` - Your backend API URL
-
-## 👥 Team
-
-Built by a team of 4 developers during Hack the North 2024:
-
-- **Tianqin Meng** - Full-stack development & AI integration
-- **Hamza Khamissa** - Frontend design & user experience
-- **David Pietrocola** - Backend architecture & GitHub analysis
-- **Saikrishna Devendiran** - Database design & authentication
-
-## 🏆 Achievements
-
-- **🥇 Hack the North 2024 Winner**
-- **36 hours** of intensive development
-- **1,710 users** in the target demographic
-- **DEI-friendly** matching (skill-based, identity-agnostic)
-
-## 🛠️ Tech Stack
-
-### Backend
-- **Flask** - REST API framework
-- **Cohere AI** - Sentiment analysis & embeddings
-- **PyGithub** - GitHub API integration
-- **scikit-learn** - Machine learning algorithms
-- **Docker** - Containerization
-
-### Frontend
-- **Next.js 14** - React framework with App Router
-- **TypeScript** - Type-safe development
-- **Tailwind CSS** - Utility-first styling
-- **Framer Motion** - Smooth animations
-- **Chart.js** - Data visualization
-- **Convex** - Real-time database & auth
-
-### Infrastructure
-- **Convex** - Database & authentication
-- **Defang** - Deployment platform
-- **GitHub Actions** - CI/CD pipeline
-
-## 📈 Performance
-
-- **< 2s** GitHub profile analysis
-- **< 500ms** matching algorithm execution
-- **95%** uptime SLA
-- **10x faster** than manual teammate finding
-
-## 🤝 Contributing
-
-We welcome contributions! Please see our [Contributing Guide](CONTRIBUTING.md) for details.
-
-1. Fork the repository
-2. Create a feature branch (`git checkout -b feature/amazing-feature`)
-3. Commit your changes (`git commit -m 'Add amazing feature'`)
-4. Push to the branch (`git push origin feature/amazing-feature`)
-5. Open a Pull Request
-
-## 📄 License
-
-This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
-
-## 🙏 Acknowledgments
-
-- **Hack the North 2024** for the incredible experience
-- **Cohere** for AI/ML capabilities
-- **GitHub** for comprehensive developer data
-- **Convex** for seamless database integration
-- **Defang** for deployment infrastructure
-
----
-
-<div align="center">
-
-**Built with ❤️ during Hack the North 2024**
-
-[🌐 Live Demo](https://hackd.dev) • [📖 Documentation](https://docs.hackd.dev) • [🐛 Report Bug](https://github.com/hackd/issues) • [✨ Request Feature](https://github.com/hackd/issues)
-
-</div>