Added detailed README with features and setup

Author: adityak-06

README.md

@@ -1 +1,116 @@
-# leetcode-ranking
+# 🚀 CodePVG LeetCode Ranking
+
+A web-based platform developed for CodePVG to track and rank students based on their LeetCode performance.  
+It allows users to register with their LeetCode username and automatically fetches their problem-solving statistics to display on a leaderboard.
+
+---
+
+## 🎯 Purpose
+
+The goal of this project is to:
+- Encourage consistent problem-solving among students 📈
+- Create a competitive yet motivating environment 🏆
+- Provide visibility into individual coding progress 💻
+
+---
+
+## 🌟 Features
+
+### 🔐 User Registration
+- Users can register using their name and LeetCode username
+- Accepts both direct usernames and profile links
+- Validates whether the LeetCode user exists before registration
+
+---
+
+### 📊 Leaderboard System
+- Displays ranked users based on their LeetCode stats
+- Automatically updates rankings based on fetched data
+- Clean UI for easy comparison between users
+
+---
+
+### 🔄 Automated Data Fetching
+- Periodically fetches user data using LeetCode API
+- Updates stored data without manual intervention
+- Ensures leaderboard stays up-to-date
+
+---
+
+### 🎨 User-Friendly Interface
+- Simple and clean UI design
+- Smooth user experience with loading states
+- Blur + spinner animation during registration (UX improvement)
+
+---
+
+### ⚡ Input Handling & Validation
+- Extracts username even from full LeetCode profile links
+- Prevents invalid or non-existent usernames
+- Avoids duplicate or incorrect entries
+
+---
+
+### 🛡️ Error Handling
+- Handles API failures gracefully
+- Displays alerts for invalid inputs
+- Prevents multiple submissions during requests
+
+---
+
+## 🛠️ Tech Stack
+
+| Layer      | Technology             |
+|------------|------------------------|
+| Frontend   | HTML, CSS, JavaScript  |
+| Backend    | Node.js                |
+| API        | LeetCode API           |
+
+---
+
+## 📂 Project Structure
+
+leetcode-ranking/
+│── frontend/ # UI (HTML, CSS, JS)
+│── data/ # Stored user data
+│── scripts/ # Automation scripts
+│── server.js # Backend server
+│── package.json
+
+
+---
+
+## 🚀 How to Run Locally
+
+### 1️⃣ Clone the repository
+
+```bash
+git clone https://github.com/YOUR-USERNAME/leetcode-ranking.git
+cd leetcode-ranking
+
+2️⃣ Install dependencies
+
+npm install
+cd frontend
+npm install
+
+3️⃣ Run the project
+
+npm run dev   OR   node server.js
+
+📌 Usage
+
+Open the registration page
+Enter your name and LeetCode username
+Submit the form
+View your ranking on the leaderboard
+🤝 Contributing
+
+
+Contributions are welcome!
+
+Fork the repo
+Create a new branch
+Make changes
+Submit a Pull Request
+