-
Notifications
You must be signed in to change notification settings - Fork 8
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Minor README Updates for Installation #1062
Merged
Merged
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
Apply Sweep Rules to your PR?
|
karkir0003
requested changes
Nov 28, 2023
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
left minor comments. looks good to me overall. thanks for this faris
Kudos, SonarCloud Quality Gate passed! |
Resolved comments @karkir0003. Thanks! |
karkir0003
approved these changes
Nov 28, 2023
approved @farisdurrani |
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.
Minor README Updates for Installation
Github Issue Number Here: #1010
What user problem are we solving?
Early in the semester, some new members had difficulty installing and starting the backend and frontend. We make slight improvements to the README, especially in adding screenshots, to help with this process.
What solution does this PR provide?
Upgraded Node version, added screenshots, linked to Bug Manual page, fixed build issue
Testing Methodology
While no testing is necessary since changes are to the README, starting the frontend showed no errors.
Any other considerations
Some items on the original Issue were not considered important enough to be added to the README, and hence they're put to the Bug Manual page, now linked