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

chore: add debug troubleshooting steps to webapp readme #141

Closed Sayvai closed 10 months ago

Sayvai commented 10 months ago

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

Proposed Changes

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.

Resume-Matcher-vs-code-debug-backend-fastapi-demo

How to Test

  1. Run the web app (follow instructions from webapp/README.md), and wait for the frontend and backend servers to completely load
  2. Open http://localhost:3000/ in a new browser tab
  3. 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

Additional Information

N/A

srbhr commented 10 months ago

@Sayvai I have merged your changes.

srbhr commented 10 months ago

Now once we solve the ongoing dependency issues with the main. After that I will merge it with the main repo.