Merge pull request #79 from CrackCode-dev/vidun-upek-patch-1

Revise README for CrackCode platform overview

Author: hasaRanger

README.md

@@ -1,205 +1,78 @@
-# JWT AUTH SETUP
-### 1. Backend Setup
-
-Navigate to the `server` directory.
-
-1.  **Install Dependencies:**
-    ```bash
-    cd server
-    npm install
-    ```
-
-2.  **Environment Configuration:**
-    Create a `.env` file in the `server` root and add your credentials:
-    ```env
-    PORT=4000
-    MONGODB_URL="your_mongodb_connection_string"
-    JWT_SECRET="your_super_secret_key"
-    NODE_ENV="development"
-
-    # Email Service (e.g., Brevo/SMTP)
-    SMTP_USER="your_smtp_user"
-    SMTP_PASSWORD="your_smtp_password"
-    SENDER_EMAIL="your_sender_email@example.com"
-    ```
-
-3.  **Start Server:**
-    ```bash
-    npm run server
-    # Server runs on http://localhost:4000
-    ```
-
-### 2. Frontend Setup
-
-Navigate to the `client` directory.
-
-1.  **Install Dependencies:**
-    ```bash
-    cd client
-    npm install
-    ```
-
-2.  **Environment Configuration:**
-    Create a `.env` file in the `client` root:
-    ```env
-    VITE_BACKEND_URL=http://localhost:4000
-    ```
-
-3.  **Start Application:**
-    ```bash
-    npm run dev
-    # App runs on http://localhost:5173
-    ```
+# 🚀 CrackCode – Gamified Coding Learning Platform
 
----
-// merge test
-
-
-node server.js
-```
+> Learn coding like solving a mystery 🕵️‍♂️  
+> Crack problems, earn rewards, level up your skills.
 
 ---
 
-## Questions API (No Auth Needed)
+## 📌 Overview
 
-### Test 1: Get All Careers
-```
-GET http://localhost:5050/api/questions/careers
-```
-**Expected:** List of 3 careers (MLEngineer, DataScientist, SoftwareEngineer)
-
----
+**CrackCode** is a full-stack gamified coding platform designed to make learning programming **engaging, interactive, and addictive**.
 
-### Test 2: Get ML Engineer Easy Questions
-```
-GET http://localhost:5050/api/questions?career=MLEngineer&difficulty=Easy
-```
-**Expected:** 20 Easy questions from MLEngineerQ collection
+Instead of traditional problem-solving, users take on the role of a **detective**, solving coding challenges to progress through cases, earn XP, unlock badges, and climb leaderboards.
 
 ---
 
-### Test 3: Get Data Scientist Medium Questions
-```
-GET http://localhost:5050/api/questions?career=DataScientist&difficulty=Medium
-```
-**Expected:** 20 Medium questions from DataScientistQ collection
+## ✨ Key Features
+
+### 🧠 Interactive Coding Experience
+- Built-in **code editor** with real-time execution
+- Supports multiple languages (Python, C++, Java, JavaScript)
+- Integrated with **Judge0 API** for code evaluation
+
+### 🎮 Gamification System
+- XP (Experience Points) system  
+- Levels & progression tracking  
+- Daily streaks 🔥  
+- Virtual currency (tokens)
+
+### 🏆 Achievements & Badges
+- Unlock badges based on milestones:
+  - First problem solved
+  - 5 / 10 / 25 problems solved
+  - Language mastery badges
+- Leaderboard ranking system
+
+### 🤖 AI-Powered Assistance
+- AI-generated hints  
+- Error diagnosis system  
+- Guided learning support  
+
+### 📊 User Analytics Dashboard
+Track user progress including:
+- Problems solved  
+- Difficulty distribution (Easy/Medium/Hard)  
+- Programming language progress  
+- XP growth  
+
+### 🔐 Authentication & Security
+- JWT-based authentication  
+- Email verification & OTP system  
+- Secure password hashing using bcrypt  
 
 ---
 
-### Test 4: Get Software Engineer Hard Questions
-```
-GET http://localhost:5050/api/questions?career=SoftwareEngineer&difficulty=Hard
-```
-**Expected:** 20 Hard questions from SoftwareEngineerQ collection
+## 🏗️ Tech Stack
 
----
+### 💻 Frontend
+- React.js  
+- Tailwind CSS  
+- Axios  
+- Vite  
 
-### Test 5: Get Questions by Category
-```
-GET http://localhost:5050/api/questions?career=SoftwareEngineer&difficulty=Hard&category=Security
-```
-**Expected:** Only Security category questions
+### ⚙️ Backend
+- Node.js  
+- Express.js  
+- MongoDB (Mongoose)  
+- Redis (Caching & performance optimization)  
 
----
+### 🧪 Code Execution
+- Judge0 API  
 
-### Test 6: Get Single Question
-```
-GET http://localhost:5050/api/questions/69b1eb1f858eabad2fed4967?career=SoftwareEngineer
-```
-(Use an actual `_id` from your Test 4 response)
+### 🐳 DevOps & Deployment
+- Docker & Docker Compose  
+- Nginx (Frontend serving)  
+- DigitalOcean (Hosting)  
+- GitHub (Version Control + CI/CD)  
 
 ---
-
-### Test 7: Submit Answer
-```
-POST http://localhost:5050/api/questions/submit
-Content-Type: application/json
-
-Body (raw JSON):
-{
-  "career": "SoftwareEngineer",
-  "questionId": "69b1eb1f858eabad2fed4967",
-  "answer": "A tree-like structure of a web page"
-}
-```
-**Expected:** `{ "success": true, "correct": true }`
-
----
-
-### Test 8: Submit Wrong Answer
-```
-POST http://localhost:5050/api/questions/submit
-Content-Type: application/json
-
-Body:
-{
-  "career": "SoftwareEngineer",
-  "questionId": "69b1eb1f858eabad2fed4967",
-  "answer": "wrong answer"
-}
-```
-**Expected:** `{ "success": true, "correct": false, "correctAnswer": "..." }`
-
----
-
-## Progress API (Auth Required)
-
-### Test 9: Login First
-```
-POST http://localhost:5050/api/auth/login
-Content-Type: application/json
-
-Body:
-{
-  "email": "your@email.com",
-  "password": "yourpassword"
-}
-```
-**Copy the token from response!**
-
----
-
-### Test 10: Get Progress (with token)
-```
-GET http://localhost:5050/api/progress?career=MLEngineer
-
-Authorization: Bearer <your_token>
-```
-In Postman: **Authorization tab → Bearer Token → Paste token**
-
----
-
-### Test 11: Update Progress
-```
-POST http://localhost:5050/api/progress/update
-Authorization: Bearer <your_token>
-Content-Type: application/json
-
-Body:
-{
-  "career": "MLEngineer",
-  "difficulty": "Easy",
-  "correct": true
-}
-```
-
----
-
-### Test 12: Get All Progress
-```
-GET http://localhost:5050/api/progress/all
-Authorization: Bearer <your_token>
-```
-
----
-
-### Test 13: Reset Progress
-```
-POST http://localhost:5050/api/progress/reset
-Authorization: Bearer <your_token>
-Content-Type: application/json
-
-Body:
-{
-  "career": "MLEngineer"
-}