|
1 | | -# Career Advisor Chatbot |
2 | | -AI Young Guru 2026 |
3 | | - |
4 | | -## Quick Start |
5 | | -- `cd backend` |
6 | | -- `npm install` |
7 | | -- `npm run setup-db` |
8 | | -- `npm run dev` |
9 | | - |
10 | | -## Single URL (Serve Frontend From Backend) |
11 | | -- `npm run build` (one-time) |
12 | | -- `npm run start` |
13 | | -- Or one command: `npm run serve` |
14 | | -- Open `http://localhost:3001` |
15 | | - |
16 | | -## API |
17 | | -Base URL: `http://localhost:3001` |
18 | | - |
19 | | -## Database Notes |
20 | | -- `npm run setup-db` now skips if DB already exists. |
21 | | -- To rebuild from scratch: `npm run reset-db` (this deletes the existing DB file). |
22 | | -- Server auto-initializes DB on first run if empty. |
23 | | - |
24 | | -## Explore Careers (Job Catalog) |
25 | | -- Job catalog uses a separate SQLite DB: `backend/database/career_catalog.db`. |
26 | | -- Import 1000+ jobs from O*NET (online) with: |
27 | | - - `npm --prefix backend run import-jobs` |
28 | | -- Reset and re-import: |
29 | | - - `npm --prefix backend run reset-jobs` |
30 | | - |
31 | | -### Data Source |
32 | | -- O*NET Database (text) download: |
33 | | - - `https://www.onetcenter.org/dl_files/database/db_30_1_text.zip` |
34 | | -- O*NET license: |
35 | | - - `https://www.onetcenter.org/license_db.html` |
36 | | - |
37 | | -## Notes |
38 | | -- Uses SQLite. Configure `DB_PATH` if needed. |
39 | | -- Scenario and matcher are rule-based for prototype speed. |
40 | | - |
41 | | -## LLM API MODEL |
42 | | -GPT OSS 120B |
43 | | -See: https://console.groq.com/playground?model=openai/gpt-oss-120b |
44 | | - |
45 | | -# Team LLMagik |
46 | | -* Phạm Khôi Nguyên https://github.com/thisIsAnVariableOfACoder |
47 | | -* Đinh Quang Minh https://github.com/minhhdinh192 |
48 | | -* Vũ Minh Hoàng https://github.com/GetInHod |
| 1 | +# Career Advisor Chatbot |
| 2 | +**AI Young Guru 2026 – Team LLMagik** |
| 3 | + |
| 4 | +An AI-powered career advisory chatbot that helps users explore career paths, discover job information, and receive personalized recommendations. |
| 5 | + |
| 6 | +--- |
| 7 | + |
| 8 | +## 🚀 Overview |
| 9 | + |
| 10 | +Career Advisor Chatbot is a prototype system designed to: |
| 11 | + |
| 12 | +- Provide career exploration support |
| 13 | +- Suggest relevant job roles |
| 14 | +- Serve a searchable job catalog (1000+ roles from O*NET) |
| 15 | +- Demonstrate LLM-powered conversational guidance |
| 16 | + |
| 17 | +### Tech Stack |
| 18 | + |
| 19 | +- **Node.js** (Backend) |
| 20 | +- **Frontend Web App** |
| 21 | +- **SQLite** (Database) |
| 22 | +- **Rule-based matching engine** (Prototype) |
| 23 | +- **LLM Integration – GPT-OSS 120B** |
| 24 | + |
| 25 | +--- |
| 26 | + |
| 27 | +## 📦 Project Structure |
| 28 | + |
| 29 | +```bash |
| 30 | +career-advisor-chatbot/ |
| 31 | +├── backend/ |
| 32 | +└── frontend/ |
| 33 | +``` |
| 34 | + |
| 35 | +--- |
| 36 | + |
| 37 | +## 🛠 Installation & Setup |
| 38 | + |
| 39 | +### 1️⃣ Backend |
| 40 | + |
| 41 | +```bash |
| 42 | +cd backend |
| 43 | +npm install |
| 44 | +npm run setup-db |
| 45 | +npm run dev |
| 46 | +``` |
| 47 | + |
| 48 | +### 2️⃣ Frontend |
| 49 | + |
| 50 | +```bash |
| 51 | +cd frontend |
| 52 | +npm install |
| 53 | +npm run dev |
| 54 | +``` |
| 55 | + |
| 56 | +--- |
| 57 | + |
| 58 | +## 🌐 Production Mode (Single URL Deployment) |
| 59 | + |
| 60 | +Serve frontend from backend: |
| 61 | + |
| 62 | +```bash |
| 63 | +cd backend |
| 64 | +npm run build # Run once |
| 65 | +npm run start |
| 66 | +``` |
| 67 | + |
| 68 | +Or run everything with one command: |
| 69 | + |
| 70 | +```bash |
| 71 | +npm run serve |
| 72 | +``` |
| 73 | + |
| 74 | +Access the application at: |
| 75 | + |
| 76 | +``` |
| 77 | +http://localhost:3001 |
| 78 | +``` |
| 79 | + |
| 80 | +--- |
| 81 | + |
| 82 | +## 🔌 API |
| 83 | + |
| 84 | +**Base URL** |
| 85 | + |
| 86 | +``` |
| 87 | +http://localhost:3001 |
| 88 | +``` |
| 89 | + |
| 90 | +--- |
| 91 | + |
| 92 | +## 🗄 Database |
| 93 | + |
| 94 | +### Main Database |
| 95 | + |
| 96 | +- Uses **SQLite** |
| 97 | +- Automatically initializes on first run |
| 98 | +- Custom path configurable via `DB_PATH` environment variable |
| 99 | + |
| 100 | +### Database Commands |
| 101 | + |
| 102 | +| Command | Description | |
| 103 | +|---------|------------| |
| 104 | +| `npm run setup-db` | Initialize database (skips if exists) | |
| 105 | +| `npm run reset-db` | Delete and recreate database | |
| 106 | +| Auto-init | Server initializes DB if empty | |
| 107 | + |
| 108 | +--- |
| 109 | + |
| 110 | +## 📚 Career Catalog (Job Explorer) |
| 111 | + |
| 112 | +The job catalog uses a separate SQLite database. |
| 113 | + |
| 114 | +### Import 1000+ Jobs from O*NET |
| 115 | + |
| 116 | +```bash |
| 117 | +npm --prefix backend run import-jobs |
| 118 | +``` |
| 119 | + |
| 120 | +### Reset & Re-import |
| 121 | + |
| 122 | +```bash |
| 123 | +npm --prefix backend run reset-jobs |
| 124 | +``` |
| 125 | + |
| 126 | +--- |
| 127 | + |
| 128 | +## 📖 Data Source |
| 129 | + |
| 130 | +- **O*NET Database (Text Version)** |
| 131 | + https://www.onetcenter.org/dl_files/database/db_30_1_text.zip |
| 132 | + |
| 133 | +- **O*NET License** |
| 134 | + https://www.onetcenter.org/license_db.html |
| 135 | + |
| 136 | +--- |
| 137 | + |
| 138 | +## 🤖 LLM Integration |
| 139 | + |
| 140 | +**Model Used:** GPT-OSS 120B |
| 141 | +https://console.groq.com/playground?model=openai/gpt-oss-120b |
| 142 | + |
| 143 | +--- |
| 144 | + |
| 145 | +## ⚙️ Architecture Notes |
| 146 | + |
| 147 | +- SQLite for lightweight local deployment |
| 148 | +- Rule-based scenario engine (optimized for rapid prototyping) |
| 149 | +- LLM for conversational intelligence |
| 150 | +- Designed for future ML-based matching extension |
| 151 | + |
| 152 | +--- |
| 153 | + |
| 154 | +## 👥 Team LLMagik |
| 155 | + |
| 156 | +- **Phạm Khôi Nguyên** |
| 157 | + https://github.com/thisIsAnVariableOfACoder |
| 158 | + |
| 159 | +- **Đinh Quang Minh** |
| 160 | + https://github.com/minhhdinh192 |
| 161 | + |
| 162 | +- **Vũ Minh Hoàng** |
| 163 | + https://github.com/GetInHod |
0 commit comments