Skip to content

[Data]: Add AI Resume Analyzer starter project#341

Open
nirvani-nj wants to merge 4 commits into
komalharshita:mainfrom
nirvani-nj:feature/ai-resume-analyzer
Open

[Data]: Add AI Resume Analyzer starter project#341
nirvani-nj wants to merge 4 commits into
komalharshita:mainfrom
nirvani-nj:feature/ai-resume-analyzer

Conversation

@nirvani-nj
Copy link
Copy Markdown
Contributor

Summary [required]

Added a new intermediate-level starter project called AI Resume Analyzer to the DevPath dataset.

This project teaches learners how to build a Flask-based resume analysis application using TF-IDF similarity, keyword extraction, PDF parsing, and beginner-friendly NLP concepts.

The starter project follows the existing DevPath educational style:

  • single-file structure
  • detailed documentation
  • roadmap-based learning
  • guided TODO sections
  • beginner/intermediate-friendly explanations

The project allows users to upload or paste resume text, compare it against a job description, identify missing keywords, and generate actionable feedback without relying on external AI APIs.


Related Issue [required]

Closes #325


Type of Change [required]

  • Bug fix — resolves a broken behaviour
  • Feature — adds new functionality
  • Data — adds new projects to data/projects.json
  • Documentation — updates docs, README, or code comments only
  • Style — CSS or visual changes only, no logic change
  • Refactor — restructures code without changing behaviour
  • Test — adds or updates tests

What Was Changed [required]

File Change made
data/projects.json Added the AI Resume Analyzer project entry with roadmap, resources, features, and starter code path
starter_code/ai_resume_analyzer.py Added a new educational Flask starter project with guided TODOs, TF-IDF explanations, keyword extraction logic, and resume analysis workflow

How to Test This PR [required]

  1. Clone this branch:
    git checkout feature/ai-resume-analyzer

  2. Install dependencies:
    pip install flask PyPDF2 scikit-learn

  3. Run the starter project:
    python starter_code/ai_resume_analyzer.py

  4. Open:
    http://127.0.0.1:5000

  5. Paste resume text and a sample job description into the UI.

Expected result:

  • The Flask application starts successfully
  • The frontend renders correctly
  • Resume analysis workflow and educational TODO structure are visible
  • No syntax or import errors occur

Test Results [required]

27 passed, 0 failed out of 27 tests

Screenshots (if UI change)

N/A


Self-Review Checklist [required]

  • I have read CONTRIBUTING.md and followed all guidelines
  • My branch name follows the convention: feat/, fix/, docs/, data/, style/, test/
  • I have run python tests/test_basic.py and all 27 tests pass
  • I have run flake8 . locally and there are no errors
  • I have not introduced any print() or console.log() debug statements
  • Every new function I wrote has a docstring
  • I have not modified files outside the scope of the linked issue
  • If I changed the UI, I tested it at 375px (mobile) and 1280px (desktop)
  • If I added a project to the dataset, it has all required JSON fields

Notes for Reviewer

The project is intentionally designed as an educational starter project rather than a fully production-ready application, following the same learning-oriented structure used by existing DevPath starter projects such as url_shortener.py and task_api.py.

@vercel
Copy link
Copy Markdown

vercel Bot commented May 19, 2026

@nirvani-nj is attempting to deploy a commit to the komalsony234-1530's projects Team on Vercel.

A member of the Team first needs to authorize it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Data]: Add project — AI Resume Analyzer

1 participant