Added detailed README with features and setup#11
Open
adityak-06 wants to merge 4 commits intocodepvg:mainfrom
Open
Added detailed README with features and setup#11adityak-06 wants to merge 4 commits intocodepvg:mainfrom
adityak-06 wants to merge 4 commits intocodepvg:mainfrom
Conversation
jagdish-15
requested changes
Apr 9, 2026
Collaborator
jagdish-15
left a comment
jagdish-15
left a comment
There was a problem hiding this comment.
Thanks for taking this up. Here are a few suggested changes:
|
|
||
| --- | ||
|
|
||
| ## Features |
Collaborator
There was a problem hiding this comment.
Let’s avoid including a features section in the README, so we don’t have to keep updating it every time new features are added.
|
|
||
| --- | ||
|
|
||
| ## Tech Stack |
Collaborator
There was a problem hiding this comment.
We already get a summary of the tech stack on the main repo page, so instead of repeating that in the README, we can link the related repos for the backend and the web scraping API (since LeetCode doesn’t officially provide one):
This would be more useful and avoid redundancy
Comment on lines
+86
to
+89
|
|
||
| npm install | ||
| cd frontend | ||
| npm install |
Collaborator
There was a problem hiding this comment.
Suggested change
| npm install | |
| cd frontend | |
| npm install | |
| `npm install` |
jagdish-15
requested changes
Apr 20, 2026
Collaborator
jagdish-15
left a comment
jagdish-15
left a comment
There was a problem hiding this comment.
Can you please make these few changes before we merge this
Comment on lines
+44
to
+45
| ### 1. Clone the repository | ||
|
|
Collaborator
There was a problem hiding this comment.
Suggested change
| ### 1. Clone the repository | |
| ### 1. Fork and clone the repository | |
| First, fork the repository to your GitHub account. Then clone it locally: |
Comment on lines
+54
to
+55
| cd frontend | ||
| `npm install` |
Collaborator
There was a problem hiding this comment.
Suggested change
| cd frontend | |
| `npm install` |
Comment on lines
+59
to
+64
|
|
||
| `npm run dev` | ||
|
|
||
| or | ||
|
|
||
| node server.js |
Collaborator
There was a problem hiding this comment.
Suggested change
| `npm run dev` | |
| or | |
| node server.js | |
| `npm run dev` | |
| or | |
| `node start` |
Comment on lines
+71
to
+72
| 4. View your ranking on the leaderboard after | ||
| the next sync |
Collaborator
There was a problem hiding this comment.
Suggested change
| 4. View your ranking on the leaderboard after | |
| the next sync | |
| 4. View your ranking on the leaderboard after the next sync |
Comment on lines
+18
to
+26
|
|
||
| This project relies on external services for fetching and processing LeetCode data. | ||
| Instead of duplicating details here, refer to the following repositories: | ||
|
|
||
| - [leetcode-api](https://github.com/codepvg/leetcode-api) – API used to fetch user data from LeetCode | ||
| - [lc-backend](https://github.com/codepvg/lc-backend) – Backend service for storing and managing leaderboard data | ||
|
|
||
| These repositories handle the core data processing and integration logic for the leaderboard. | ||
|
|
Collaborator
There was a problem hiding this comment.
Suggested change
| This project relies on external services for fetching and processing LeetCode data. | |
| Instead of duplicating details here, refer to the following repositories: | |
| - [leetcode-api](https://github.com/codepvg/leetcode-api) – API used to fetch user data from LeetCode | |
| - [lc-backend](https://github.com/codepvg/lc-backend) – Backend service for storing and managing leaderboard data | |
| These repositories handle the core data processing and integration logic for the leaderboard. | |
| ## Related Repositories | |
| This project relies on external services for fetching and processing LeetCode data. | |
| Instead of duplicating details here, refer to the following repositories: | |
| - [leetcode-api](https://github.com/codepvg/leetcode-api) – API used to fetch user data from LeetCode | |
| - [lc-backend](https://github.com/codepvg/lc-backend) – Backend service for storing and managing leaderboard data | |
| - [frontend-uptime-monitor](https://github.com/codepvg/frontend-uptime-monitor) – Pinger service to monitor frontend server uptime | |
| - [backend-uptime-monitor](https://github.com/codepvg/backend-uptime-monitor) – Pinger service to monitor backend server uptime | |
| These repositories handle the core data processing and integration logic for the leaderboard. | |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
📄 README Enhancement
This PR adds a detailed and structured README.md to improve project understanding for new users and contributors.
✨ Changes Made
🎯 Impact
Closes #5