srbhr / Resume-Matcher

Resume Matcher is an open source, free tool to improve your resume. It works by using language models to compare and rank resumes with job descriptions.
https://www.resumematcher.fyi/
Apache License 2.0
4.72k stars 1.86k forks source link

feat: add full stack web app #120

Closed Sayvai closed 10 months ago

Sayvai commented 10 months ago

Implement Full Stack Web Application (Frontend Client and Backend API)

This change implements a new Full Stack Next.js web application, combining two core modern-day powerful technologies (React.js and FastAPI).

Related Issue

N/A

Description

The result of the implementation is a fully functioning interactive frontend client that is accessible from the web browser, allowing the user to preview and upload their resumes and multiple job details (link and descriptions) to the backend API, to then be able to take in the user-submitted data, and return out (currently mocked) results, such as vector scores, common words, and suggestions against multiple jobs.

At the moment, the API returns a mocked response, but the API response model is provisionally defined, and so this should make it simpler to get started with integrating new and existing Python scripts to return the results in a structured data format for the frontend client to automatically parse and render back out to the user.

Type

Proposed Changes

Screenshots / Code Snippets (if applicable)

Here is a short GIF demo of the frontend client interaction, which ultimately dynamically renders out the mocked response from the backend API.

Resume-Matcher-Web-App-UI-Quick-Demo-2

How to Test

Instructions on running the full stack web application is set out in the webapp/README.md file

Checklist

Additional Information

srbhr commented 10 months ago

Hey @Sayvai Dude this is some awesome work! Thanks a lot for doing this. Can you join in the Discord and share about it during this Weekend? We have our usual weekly calls at that time, and I would love to know, how you did this all, and how can we implement new features on top of this. As there are ongoing discussions about this.

Link to discord: https://dsc.gg/resume-matcher

srbhr commented 10 months ago

Hi @Sayvai can you raise the PR to this branch: https://github.com/srbhr/Resume-Matcher/tree/resume-matcher-fullstack-webapp

This will contain the code to run the webapp. Also, please fix the merge conflict with the requirements.txt file.

Sayvai commented 10 months ago

Hi @srbhr - I've resolved the merge conflict on the requirements.txt file, and have changed the base branch on this pull request to point to srbhr:resume-matcher-fullstack-webapp.

If you could, I would advise for you to select to option to Squash Merge (or Rebase Merge, since I pre-squashed all commits on my PR branch already), as that would only introduce one clean commit onto the git log history of the base branch, without adding an additional standalone merge commit (unnecessarily). Totally up to you, as it's just my preferred Git workflow approach, personally 🙂

srbhr commented 10 months ago

@Sayvai this PR is now merged! thanks for this