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.
Add new sections labelled Debugging and Troubleshooting Common Issues to the webapp README.md file
This change is to add new sections labelled Debugging and Troubleshooting Common Issues to the webapp/README.md file.
The debugging section guides users on how to run the FastAPI backend server in VS Codes' debug mode, along with running the frontend server in isolation.
The troubleshooting section currently highlights one potential common issue that users may encounter when only running the frontend server in isolation (e.g. npm run next-dev).
Related Issue
N/A
Type
[ ] Bug Fix
[ ] Feature Enhancement
[X] Documentation Update
[ ] Code Refactoring
[ ] Other (please specify):
Proposed Changes
Update webapp/README.md with new sections
Screenshots / Code Snippets (if applicable)
GIF demonstration of how to run the FastAPI backend server in VS Code Debugger mode, from within the full stack web app Next.js project.
How to Test
Run the web app (follow instructions from webapp/README.md), and wait for the frontend and backend servers to completely load
Replace the existing placeholder service key values from the top of the web app UI page with your own, or any other example values (see example GIF attached to this Pull Request above)
Checklist
[X] The code compiles successfully without any errors or warnings
[X] The changes have been tested and verified
[X] The documentation has been updated (if applicable)
[X] The changes follow the project's coding guidelines and best practices
[X] The commit messages are descriptive and follow the project's guidelines
[ ] All tests (if applicable) pass successfully
[ ] This pull request has been linked to the related issue (if applicable)
Add new sections labelled
Debugging
andTroubleshooting Common Issues
to the webapp README.md fileThis change is to add new sections labelled
Debugging
andTroubleshooting Common Issues
to thewebapp/README.md
file.The debugging section guides users on how to run the FastAPI backend server in VS Codes' debug mode, along with running the frontend server in isolation.
The troubleshooting section currently highlights one potential common issue that users may encounter when only running the frontend server in isolation (e.g.
npm run next-dev
).Related Issue
N/A
Type
Proposed Changes
webapp/README.md
with new sectionsScreenshots / Code Snippets (if applicable)
GIF demonstration of how to run the FastAPI backend server in VS Code Debugger mode, from within the full stack web app Next.js project.
How to Test
Checklist
Additional Information
N/A