dpv007 commited on
Commit
2da55fa
Β·
verified Β·
1 Parent(s): 9da3acc

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +8 -98
README.md CHANGED
@@ -1,99 +1,9 @@
1
- # SkillForge AI
2
-
3
- > **From resume claims to real capability.**
4
-
5
- A next-generation AI agent that takes a Job Description and a candidate's resume, conversationally assesses real proficiency on each required skill, identifies gaps, and generates a personalised learning plan focused on adjacent skills the candidate can realistically acquire β€” with curated resources and time estimates.
6
-
7
- No simple keyword matching. No generic RAG. Pure **Knowledge Graph traversal** + **multi-agent real-time conversation**.
8
-
9
  ---
10
-
11
- ## ⚑ Architecture & Tech Stack
12
-
13
- SkillForge AI is built as a full-stack monorepo featuring a powerful Python/AI backend and a blazing fast Next.js frontend.
14
-
15
- ### Backend (AI & Logic)
16
- - **Framework:** FastAPI
17
- - **Agent Orchestration:** LangGraph (Multi-agent state machines)
18
- - **LLM Engine:** LangChain + Groq (`llama-3.3-70b-versatile`) for lightning-fast inference
19
- - **Knowledge Graph:** NetworkX (Directed graphs with custom edge weights)
20
- - **PDF Processing:** `pdfplumber` for clean JD/Resume extraction
21
-
22
- ### Frontend (User Interface)
23
- - **Framework:** Next.js 14 (App Router)
24
- - **Styling:** Tailwind CSS + Enterprise Light Theme
25
- - **State Management:** Zustand
26
- - **Streaming:** Server-Sent Events (SSE) via native Web API `EventSource`
27
-
28
- ---
29
-
30
- ## 🧠 How it Works
31
-
32
- 1. **Extraction (`extractor.py`):** An LLM extracts structured capabilities from the candidate's resume and the target job description.
33
- 2. **Gap Analysis (`claim_vs_reality.py`):** Cross-references resume claims against job requirements to flag high-priority gaps.
34
- 3. **Conversational Assessment (`interviewer.py` & `scorer.py`):** The agent engages the candidate in a dynamic, progressive Q&A to verify actual competency rather than just stated experience.
35
- 4. **Targeted Challenges (`challenger.py`):** For intermediate/senior skills, the agent generates grounded "find-the-bug" style micro-challenges.
36
- 5. **Roadmap Generation (`roadmap_generator.py` & `roadmap_builder.py`):** The Knowledge Graph engine calculates the shortest learning path. A dedicated AI Roadmap Builder then synthesizes the candidate's exact performance scores and target domain to generate a custom 3-tier weekly syllabus, complete with personalized mini-projects and rationales.
37
-
38
- ---
39
-
40
- ## πŸš€ Running Locally
41
-
42
- ### 1. Start the FastAPI Backend
43
- You will need a [Groq API Key](https://console.groq.com/keys) to run the LLM models.
44
-
45
- ```bash
46
- cd backend
47
- python -m venv venv
48
-
49
- # Windows
50
- .\venv\Scripts\Activate.ps1
51
- # Mac/Linux
52
- source venv/bin/activate
53
-
54
- pip install -r requirements.txt
55
-
56
- # Set up your environment variables
57
- cp .env.example .env
58
- # Edit .env and add your GROQ_API_KEY
59
-
60
- uvicorn main:app --reload --port 8000
61
- ```
62
- *The backend API will be running at `http://localhost:8000`*
63
-
64
- ### 2. Start the Next.js Frontend
65
- In a new terminal window:
66
-
67
- ```bash
68
- cd frontend
69
- npm install
70
-
71
- # Ensure your local environment is pointing to the backend
72
- cp .env.local.example .env.local
73
-
74
- npm run dev
75
- ```
76
- *The frontend will be running at `http://localhost:3000`*
77
-
78
- ---
79
-
80
- ## πŸ“‚ Repository Structure
81
-
82
- ```text
83
- skillforge-ai/
84
- β”œβ”€β”€ backend/ # Python FastAPI Backend
85
- β”‚ β”œβ”€β”€ agents/ # LangChain/Groq agent definitions
86
- β”‚ β”œβ”€β”€ data/ # Sample JDs and Resumes
87
- β”‚ β”œβ”€β”€ graph_pipeline/ # LangGraph state machine & nodes
88
- β”‚ β”œβ”€β”€ knowledge_graph/ # NetworkX implementation & static graph JSON
89
- β”‚ β”œβ”€β”€ models/ # Pydantic data schemas
90
- β”‚ β”œβ”€β”€ output/ # Roadmap synthesis logic
91
- β”‚ β”œβ”€β”€ routers/ # FastAPI endpoints (Upload, Assess, Roadmap)
92
- β”‚ └── scoring/ # Algorithmic mismatch and gap scoring
93
- β”‚
94
- └── frontend/ # Next.js 14 Frontend
95
- β”œβ”€β”€ app/ # Next.js App Router pages
96
- β”œβ”€β”€ components/ # React components (Upload, Assessment, Results)
97
- β”œβ”€β”€ hooks/ # Custom React hooks (e.g. SSE streaming)
98
- └── lib/ # API clients, Zustand store, and TS Types
99
- ```
 
 
 
 
 
 
 
 
 
1
  ---
2
+ title: SkillForge
3
+ emoji: πŸ› οΈ
4
+ colorFrom: blue
5
+ colorTo: indigo
6
+ sdk: docker
7
+ pinned: false
8
+ short_description: From resume claims to real capability.
9
+ ---