DSGT-DLP / Deep-Learning-Playground

Web Application where people new to Deep Learning can input a dataset and toy around with basic Pytorch modules without writing any code
MIT License
26 stars 8 forks source link

Minor README Updates for Installation #1062

Closed farisdurrani closed 11 months ago

farisdurrani commented 11 months ago

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

How did you test your changes and verify that existing functionality is not broken

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

sweep-ai[bot] commented 11 months ago

Apply Sweep Rules to your PR?

sonarcloud[bot] commented 11 months ago

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
No Duplication information No Duplication information

farisdurrani commented 11 months ago

Resolved comments @karkir0003. Thanks!

karkir0003 commented 11 months ago

approved @farisdurrani