josaa-rank-predictor/QUICKSTART.txt at main · Charandeep2/josaa-rank-predictor · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
╔════════════════════════════════════════════════════════════════╗
║                                                                ║
║        JoSAA COLLEGE PREDICTOR - QUICK START GUIDE            ║
║                                                                ║
╚════════════════════════════════════════════════════════════════╝

🚀 FASTEST WAY TO GET STARTED (Windows)
========================================

1. Double-click: setup_and_run.bat
2. Wait for installation to complete
3. Browser will open automatically at http://localhost:3000
4. Click "Train Models" tab → Click "Train All Models" button
5. Click "Predict Colleges" tab → Enter your rank → Get predictions!

Done! 🎉

────────────────────────────────────────────────────────────────

📋 MANUAL SETUP (If automated setup doesn't work)
=================================================

Step 1: Install Python packages
    pip install -r requirements.txt

Step 2: Generate sample data
    python generate_sample_data.py

Step 3: Install Node packages
    npm install

Step 4: Start backend (in first terminal)
    python app.py

Step 5: Start frontend (in second terminal)
    npm run dev

Step 6: Open browser
    http://localhost:3000

────────────────────────────────────────────────────────────────

🎯 WHAT YOU CAN DO
==================

✓ Train 3 ML models (XGBoost, Logistic Regression, Random Forest)
✓ Upload your own JoSAA CSV data
✓ Get instant college predictions based on rank & category
✓ Compare predictions across all three models
✓ See consensus predictions (agreed by 2+ models)
✓ Modify inputs and get real-time updates

────────────────────────────────────────────────────────────────

📊 CSV DATA FORMAT
==================

Your CSV should have these columns:
rank,category,institute,branch,year

Example:
156,OPEN,IIT Bombay,Computer Science and Engineering,2024
450,OBC-NCL,IIT Delhi,Electrical Engineering,2024

────────────────────────────────────────────────────────────────

❓ TROUBLESHOOTING
==================

Problem: Setup fails
→ Make sure Python 3.8+ and Node.js 16+ are installed

Problem: "Models not trained"
→ Click "Train Models" tab and train first

Problem: Port already in use
→ Close other apps using ports 3000 or 5000

Problem: Can't connect to backend
→ Check if Flask server is running (python app.py)

────────────────────────────────────────────────────────────────

📞 NEED MORE HELP?
==================

See README.txt for detailed documentation

────────────────────────────────────────────────────────────────