chore: add debug troubleshooting steps to webapp readme #141
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sayvai
force-pushed
the
resume-matcher-fullstack-webapp
branch
2 times, most recently
from
cc3efa3 to
9d656c5
Compare
This change is to add new sections labelled `Debugging` and `Troubleshooting` 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`).
Sayvai
force-pushed
the
resume-matcher-fullstack-webapp
branch
from
9d656c5 to
d960f14
Compare
srbhr
approved these changes
Sep 13, 2023
|
@Sayvai I have merged your changes. |
|
Now once we solve the ongoing dependency issues with the main. After that I will merge it with the main repo. |
srbhr
added a commit
that referenced
this pull request
Sep 16, 2023
* feat: add full stack web app Adds in a nextjs and fastapi webapp (experimental) * feat: render save service keys on web app ui (#135) * feat: render save service keys on web app ui Implemented new feature to allow users to view the required configurable service keys (and urls) to set, on the web app UI. The configurable required service keys data is dynamically derived from the backend master YAML config file (located in `/scripts/similarity/config.yml`), and its actual pre-saved secret key values derived from a localised programatically created git-ignored YAML secrets config file (located in `/scripts/similarity/config.local.yml`). Whenever a key is no longer required by the app, then it is safe to remove key from the master config file, and in turn this key and any pre-saved secret value will no longer render on the web UI. If a secret has yet to be set for any of the required keys, then the value will fallback to the default placeholder value defined in the master YAML config. * chore: update next.js version and dependencies * chore: error handling for missing keys config file Add error handling on the backend api for when `similarity/config.yaml` does not exist, to which it responds with a 404 not found response. As a result, also added error handling on the frontend ui code to handle the above 404 backend api response edge case to not render the Service Keys ui section. * chore: ui refactor resume.tsx to hero.tsx Logically abstracted out and renamed `Hero` component to its own folder, and corrected / renamed component filename. * chore: sync requirements.txt from upstream Pulled a bugfix for `requirements.txt` file from upstream fork origin repo main branch, which broke the webapp backend server run. Root cause was that the qdrant-client dependency was set with a specific version; `qdrant-client>=1.1.1`, but the upstream reversion fix; `qdrant-client` without explicitly specifying a version resolved the webapp backend server run issue. * chore: add debug troubleshooting steps to webapp readme (#141) This change is to add new sections labelled `Debugging` and `Troubleshooting` 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`). --------- Co-authored-by: Sayvai <sayvai@hotmail.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add new sections labelled
DebuggingandTroubleshooting Common Issuesto the webapp README.md fileThis change is to add new sections labelled
DebuggingandTroubleshooting Common Issuesto thewebapp/README.mdfile.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.mdwith 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